SEO

Author: crmne

docs/Gemfile

@@ -11,4 +11,5 @@ group :jekyll_plugins do
   gem 'jekyll-sitemap'
   gem 'jekyll-og-image'
   gem 'jekyll-redirect-from'
+  gem 'jekyll-ai-visible-content'
 end

docs/_config.yml

@@ -2,6 +2,9 @@ title: RubyLLM
 description: One beautiful API for ChatGPT, Claude, Gemini, and more. Chat, images, embeddings, tools.
 url: https://rubyllm.com
 baseurl: /
+lang: en-US
+locale: en_US
+repository: crmne/ruby_llm
 remote_theme: just-the-docs/just-the-docs
 
 # Collections for organizing content
@@ -42,21 +45,29 @@ defaults:
       type: "getting_started"
     values:
       layout: "default"
+      seo:
+        type: "WebPage"
   - scope:
       path: ""
       type: "core_features"
     values:
       layout: "default"
+      seo:
+        type: "WebPage"
   - scope:
       path: ""
       type: "advanced"
     values:
       layout: "default"
+      seo:
+        type: "WebPage"
   - scope:
       path: ""
       type: "reference"
     values:
       layout: "default"
+      seo:
+        type: "WebPage"
 
 logo: "/assets/images/logotype.svg"
 favicon_ico: "/assets/images/logo.svg"
@@ -65,6 +76,13 @@ twitter:
   username: paolino
   card: summary_large_image
 
+social:
+  name: RubyLLM
+  links:
+    - https://github.com/crmne/ruby_llm
+    - https://rubygems.org/gems/ruby_llm
+    - https://github.com/sponsors/crmne
+
 search_enabled: true
 search:
   heading_level: 2
@@ -114,6 +132,97 @@ plugins:
   - jekyll-sitemap
   - jekyll-og-image
   - jekyll-redirect-from
+  - jekyll-ai-visible-content
+
+author:
+  type: Organization
+  name: RubyLLM
+  url: https://rubyllm.com
+  twitter: paolino
+
+ai_visible_content:
+  enabled: true
+  entity:
+    type: Organization
+    id_slug: ruby-llm
+    name: RubyLLM
+    alternate_names:
+      - ruby_llm
+      - Ruby LLM
+    description: one consistent Ruby API for chat, image generation, embeddings, transcription, moderation, tools, agents, structured output, streaming, and Rails integration across OpenAI, Anthropic, Gemini, Bedrock, DeepSeek, Mistral, Ollama, OpenRouter, Perplexity, GPUStack, xAI, and OpenAI-compatible providers.
+    image: /assets/images/logotype.jpg
+    same_as:
+      - https://github.com/crmne/ruby_llm
+      - https://rubygems.org/gems/ruby_llm
+      - https://github.com/sponsors/crmne
+    knows_about:
+      - Ruby
+      - Ruby on Rails
+      - Large language models
+      - AI agents
+      - Retrieval augmented generation
+      - Function calling
+      - Structured output
+      - Vector embeddings
+      - Streaming AI responses
+      - Multi-modal AI
+      - OpenAI
+      - Anthropic Claude
+      - Google Gemini
+      - AWS Bedrock
+      - DeepSeek
+      - Mistral AI
+      - xAI
+      - OpenRouter
+      - Perplexity
+      - Ollama
+      - Vertex AI
+      - GPUStack
+      - OpenAI-compatible APIs
+  json_ld:
+    auto_inject: false
+    include_website_schema: true
+    include_breadcrumbs: true
+    include_blog_posting: false
+    include_faq: true
+    include_how_to: true
+    article_body: excerpt
+    compact: true
+  crawlers:
+    allow_gptbot: true
+    allow_perplexitybot: true
+    allow_claudebot: true
+    allow_googlebot: true
+    allow_bingbot: true
+    generate_robots_txt: true
+  llms_txt:
+    enabled: true
+    title: RubyLLM Documentation
+    description: Developer documentation for RubyLLM, a Ruby library for building AI applications with chat, agents, tools, embeddings, image generation, audio transcription, moderation, streaming, and Rails integration.
+    include_full_text: true
+    sections:
+      - heading: Canonical Resources
+        content: |
+          - Documentation: https://rubyllm.com
+          - Source code: https://github.com/crmne/ruby_llm
+          - RubyGems package: https://rubygems.org/gems/ruby_llm
+      - heading: Primary Topics
+        content: |
+          RubyLLM covers provider-agnostic AI application development in Ruby, including OpenAI, Anthropic, Gemini, Bedrock, DeepSeek, Mistral, Ollama, OpenRouter, Perplexity, GPUStack, xAI, OpenAI-compatible APIs, agents, tools, structured output, embeddings, image generation, audio transcription, moderation, streaming, Rails integration, async workloads, model registry usage, and upgrade guidance.
+  linking:
+    enable_entity_links: false
+    apply_to_metadata: false
+    enable_related_posts: false
+  validation:
+    warn_name_inconsistency: false
+    warn_missing_same_as: true
+    warn_missing_dates: false
+    warn_orphan_pages: false
+    warn_missing_descriptions: true
+    fail_build_on_error: false
+    content_only: true
+    verbose: false
+    max_examples: 5
 
 # Jekyll uses Dart Sass; suppress deprecations emitted by upstream theme styles.
 sass:

docs/_includes/head.html

@@ -47,6 +47,7 @@
   {% include_cached favicon.html %}
 
   {% seo %}
+  {% ai_json_ld %}
 
   {% include head_custom.html %}
 </head>

docs/_plugins/ai_visible_content_collection_json_ld.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# jekyll-ai-visible-content's manual {% ai_json_ld %} tag searches pages and
+# posts. RubyLLM's docs live mostly in custom collections, so include those too.
+module JekyllAiVisibleContentCollectionJsonLd
+  private
+
+  def find_page_object(site, page_hash)
+    super || collection_doc(site, page_hash)
+  end
+
+  def collection_doc(site, page_hash)
+    url = page_hash['url'] || page_hash['permalink']
+    site.collections.values.flat_map(&:docs).find { |doc| doc.url == url }
+  end
+end
+
+Jekyll::Hooks.register :site, :after_init do
+  next unless defined?(JekyllAiVisibleContent::Tags::AiJsonLdTag)
+
+  tag = JekyllAiVisibleContent::Tags::AiJsonLdTag
+  next if tag < JekyllAiVisibleContentCollectionJsonLd
+
+  tag.prepend(JekyllAiVisibleContentCollectionJsonLd)
+end

docs/_plugins/document_collection_seo.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Jekyll assigns custom collection documents a synthetic date based on build
+# time. These docs are evergreen reference pages, so hide that synthetic date
+# from Liquid consumers such as jekyll-seo-tag.
+module RubyLlmDocumentCollectionSeo
+  DOC_COLLECTIONS = %w[
+    getting_started
+    core_features
+    advanced
+    reference
+  ].freeze
+
+  def date
+    return nil if docs_collection?
+
+    super
+  end
+
+  private
+
+  def docs_collection?
+    @obj.respond_to?(:collection) && DOC_COLLECTIONS.include?(@obj.collection.label)
+  end
+end
+
+Jekyll::Drops::DocumentDrop.prepend(RubyLlmDocumentCollectionSeo)

docs/about.md

@@ -0,0 +1,28 @@
+---
+layout: default
+title: About RubyLLM
+description: RubyLLM is an open source Ruby gem for building AI applications across major model providers with one consistent Ruby API.
+permalink: /about/
+nav_exclude: true
+search_exclude: true
+entity_type: Organization
+image: /assets/images/logotype.jpg
+topics:
+  - Ruby
+  - Large language models
+  - AI agents
+  - Ruby on Rails
+  - OpenAI
+  - Anthropic Claude
+  - Google Gemini
+  - AWS Bedrock
+  - Ollama
+---
+
+# About RubyLLM
+
+RubyLLM is an open source Ruby gem that gives developers one consistent API for building AI applications across OpenAI, Anthropic, Gemini, Bedrock, DeepSeek, Mistral, Ollama, OpenRouter, Perplexity, GPUStack, xAI, and OpenAI-compatible providers.
+
+It supports chat, multi-modal inputs, image generation, embeddings, audio transcription, moderation, tools, agents, structured output, streaming, Rails integration, async workloads, and model registry access.
+
+RubyLLM is maintained by [Carmine Paolino](https://paolino.me) and developed in the open on [GitHub](https://github.com/crmne/ruby_llm). The published gem is available on [RubyGems](https://rubygems.org/gems/ruby_llm).

docs/index.md

@@ -1,6 +1,6 @@
 ---
 layout: default
-title: Home
+title: RubyLLM
 nav_order: 1
 description: One beautiful Ruby API for GPT, Claude, Gemini, and more. Easily build chatbots, AI agents, RAG applications, and content generators.
 permalink: /