feat(docs): split llms.txt into spec-compliant index and full dump#2283
Open
asblanco wants to merge 2 commits into
Open
feat(docs): split llms.txt into spec-compliant index and full dump#2283asblanco wants to merge 2 commits into
asblanco wants to merge 2 commits into
Conversation
✅ Deploy Preview for stacks ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
CodeQL js/incomplete-multi-character-sanitization flagged the single-pass regex strip in llms.11ty.js because an unclosed `<script` (missing `>`) would leave the pattern in the output. Loop the replace until the string is stable, per CodeQL's recommended fix. Output is unchanged for all current inputs (frontmatter descriptions are author-written and well-formed); this is defense in depth.
4 tasks
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
2 participants
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.
Context
eleventy-plugin-llms-txtproduces a content-dump shape (# Site Content for LLMs+### Page:+ full body per entry) that does not match the llmstxt.org shape (H1 + blockquote summary + H2 sections + markdown link lists). The plugin has no config option that produces the spec shape — it's structurally a content dumper.Description
/llms.txt— spec-compliant index. One H1, blockquote summary, 4 H2 sections (Base utilities, Components, Develop, Foundation), and a- [title](url): descriptionline per page. HTML stripped from descriptions. ~17 KB / 76 entries./llms-full.txt— full content dump for tools that chunk page bodies (e.g. the MCP search index). Same output the plugin previously produced at/llms.txt, just at the new filename. ~440 KB.Note
Why both files?
Only
/llms.txtis in the llmstxt.org spec — the index is the standardized artifact./llms-full.txtis an ecosystem convention (Mintlify, FernHQ, and others publish it) used to ship a full-content companion. We need it so the MCP search index has body content to chunk.Warning
Coordination
A follow-up stacks-mcp-server PR #9 flips the v2 source URL from
/llms.txtto/llms-full.txt. That PR is waiting on this one to deploy.Test plan
_site/llms.txtmatches spec shape (1 H1, 1 blockquote, 4 H2s, 76 link-list entries)._site/llms-full.txtmatches previous/llms.txtcontent.curl https://v2.stackoverflow.design/llms.txtreturns the spec-shape index.curl https://v2.stackoverflow.design/llms-full.txtreturns the full content dump.JIRA: STACKS-864