feat(docs): improve LLM/search discoverability of docs#566
Open
bensabic wants to merge 5 commits into
Open
Conversation
Add a title template in the root layout so every page's <title> and og:title render as "<Page> | Chat SDK", with explicit og:title strings on pages that set their own openGraph. The home page stays "Chat SDK". Also registers a <link rel="llms-txt"> on every page.
Surface a plain-markdown URL for every docs and adapter page via an sr-only, aria-hidden link (for AI/LLM crawlers) plus a text/markdown alternate. - Add an /adapters/<group>/<slug>.md endpoint (new adapters.mdx route + proxy rewrite) that serves the adapter's README or MDX body. - Extract shared README resolution into lib/geistdocs/adapter-readme.ts, deduped from the community and vendor-official pages, and add getAdapterLLMText. - Fix the docs markdown alternate to join nested slugs with "/".
Rewrite llms.txt as a curated index that links to the markdown version of every docs and adapter page, grouped by section. Move the previous full-text concatenation of every page to llms-full.txt.
Add content-validation tests guarding the invariants the llms.txt index and the markdown routes rely on: every docs page has a title and description, and adapter content groups map to well-formed /adapters/<group>/<slug>.md URLs.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The integration-tests package is private and already in the changeset `ignore` list, so changes to it should not require a changeset. Skip it in the "packages changed" detection like packages/chat/resources.
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.
SEO/AEO improvements for the docs site:
| Chat SDKto every page's<title>andog:title(home staysChat SDK).sr-onlyAI/LLM hint link and atext/markdownalternate; adapter pages get a new/adapters/<group>/<slug>.mdendpoint.llms.txtinto a sitemap-style index linking to each page's markdown, and move the full-text concatenation tollms-full.txt. A<link rel="llms-txt">is added to every page.