feat(docs): split v3 llms.txt into spec-compliant index and full dump#2284
Open
asblanco wants to merge 1 commit into
Open
feat(docs): split v3 llms.txt into spec-compliant index and full dump#2284asblanco wants to merge 1 commit into
asblanco wants to merge 1 commit into
Conversation
|
✅ Deploy Preview for stacks ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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.
Summary
Mirrors the v2 split (#2283) for the v3 docs. The previous
/llms.txtroute produced a content-dump shape that doesn't match llmstxt.org (which wants an H1 + blockquote summary + H2 sections + markdown link lists).This PR:
/llms.txt— spec-compliant index. One# StacksH1, blockquote summary, 9 H2 sections (Brand, Copywriting, Develop, Accessibility, Foundation, Base, Forms, Components, Resources), and- [Title](url): descriptionper page. HTML stripped from descriptions with the loop-until-stable pattern (CodeQLjs/incomplete-multi-character-sanitization). ~15 KB / 89 entries./llms-full.txt— full content dump. Same content the previous/llms.txtproduced, just at the new filename, plus the empty-collection bug fix.Note
Implementation notes
/llms.txtreads markdown frontmatter via Vite's?rawquery rather than loading the compiled Svelte page module. This keeps the index independent of every page component's imports — a missing icon export in a leaf component can't break the index.structure.yaml(e.g. the standalonechangelog.md) are skipped from the index by design — the YAML is the site's nav source of truth and decides what's a "page" worth indexing.Warning
Coordination
Once this deploys, stacks-mcp-server PR #10 flips the Stacks v3 source URL in
documentation-fetcher.tsfrom/llms.txtto/llms-full.txt. That PR is the v3 counterpart to stacks-mcp-server PR #9, which does the same for v2.Test plan
curl http://localhost:5173/llms.txtreturns 200 with spec shape (1 H1, 1 blockquote, 9 H2 sections, 89 link-list entries). Folder-index pages get trailing-slash URLs; plain.mdpages don't.curl https://stackoverflow.design/llms.txtreturns the spec-shape index.curl https://stackoverflow.design/llms-full.txtreturns the full content dump.JIRA: STACKS-864