Repository navigation
feat: publish llms.txt and llms-full.txt for AI agents - #80
Merged
Merged
Conversation
Turns on MkDocs NG's built-in llms_txt plugin. It writes llms.txt at the site root, linking the Markdown copy of every page by nav section, and llms-full.txt with all pages in one file. Sumi already announces llms.txt in each page's head once the file exists.
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 59 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
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.
Before / after
https://commit-check.com/llms.txthttps://commit-check.com/llms-full.txt<head>of each page<link rel="alternate" type="text/plain" href="llms.txt">(Sumi adds it once the file exists)Start of the generated
llms.txt:Why
Agents and their docs tools fetch
llms.txtfirst. commitlint publishes both files; commit-check had neither.How
One plugin line in
mkdocs.yml: MkDocs NG's built-inllms_txtwithfull_output: true, beforesumias Sumi's README shows. No new dependency, and both files are rebuilt from the pages on every deploy, so nothing to maintain.Checks
SOCIAL_CARDS=false mkdocs build --strictpasses; every link inllms.txtpoints to a file the build wrote.python -m pytest tests/ -q: 18 passed.Note: the home page is mostly HTML, so its section of
llms-full.txtis HTML too. The plugin has no per-page exclude; left as is.