feat(docs): SEO and AEO optimization#373
Merged
Merged
Conversation
Make the cMCP docs discoverable by search engines and answer engines (LLMs) without changing any product behavior. - Add mkdocs-llmstxt plugin: generates /llms.txt and /llms-full.txt at the site root with a curated summary and section links. - Add robots.txt (copied into the docs build) that welcomes AI crawlers (GPTBot, ClaudeBot, PerplexityBot, Google-Extended, CCBot, others) and points to the sitemap. - Add JSON-LD structured data via a theme override (SoftwareApplication, Organization, WebSite) plus Open Graph and Twitter card meta. - Add an FAQ section with FAQPage structured data on the home page. - Add answer-first lead and TL;DR to the home page; add meta descriptions to the quickstart and concepts pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Adds a 1200x630 Open Graph card served at /docs/assets/og.png and wires og:image plus twitter:image (summary_large_image). Corrects the publisher name in JSON-LD from AgentTrust to AgenTrust. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Makes the cMCP docs discoverable by both search engines (SEO) and answer engines / LLMs (AEO). Additive only, no product or runtime changes.
Changes
AEO (LLM / answer-engine pickup)
mkdocs-llmstxtplugin generates/llms.txt(curated map) and/llms-full.txt(full corpus) at the site root.robots.txtexplicitly welcomes AI crawlers (GPTBot, OAI-SearchBot, ChatGPT-User, ClaudeBot, anthropic-ai, Claude-Web, PerplexityBot, Google-Extended, CCBot) and points to the sitemap. Wired into the docs build assemble step so it lands at the site root.overrides/main.html):SoftwareApplication,Organization,WebSite.FAQPagestructured data plus a human-readable FAQ on the home page.SEO
Verification (built locally via the CI assemble step)
mkdocs buildsucceeds (only pre-existing unrelated link warnings)site/llms.txtandsite/llms-full.txtgeneratedsite/robots.txtpresent at root, with sitemap referencesite/sitemap.xmlpresent (Material auto-generates from site_url)Notes / follow-ups
README.md) intentionally has no YAML front matter (it is dual-purpose for the GitHub repo page); it inheritssite_descriptionfor its meta description.og:imageyet: only an SVG icon exists, and Open Graph needs a raster image. A 1200x630 social card is a good follow-up. The Material social plugin was intentionally not enabled because the docs CI runner lacks cairo/pango.🤖 Generated with Claude Code