Add llms.txt and llms-full.txt for AI tools#42728
Open
mdo wants to merge 1 commit into
Open
Conversation
Generate /llms.txt (a curated, llmstxt.org-style index of the docs) and /llms-full.txt (the full docs text concatenated for ingestion) from the sidebar and docs content, and link both from the install page.
Member
|
Maybe we could have a "llms.txt" entry in our "Getting started" as well like it's done in shadcn/ui docs at https://ui.shadcn.com/docs/installation: 
Clicking on it shows the raw file. I suppose it's also helpful for AI agents parsing the website for info. |
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.
Publishes machine-readable docs following the llms.txt convention.
/llms.txt: a curated index of every docs page with links and descriptions, generated from the sidebar/llms-full.txt: the full docs text concatenated into a single file for direct ingestionsite/src/libs/llms.tsresolves sidebar entries to docs content (resilient: skips stray entries instead of failing the build)