RFC: feat: add llms.txt generation #1098
Open
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.
This adds generation of llms.txt, which is used there and there by various libraries, to expose API, documentationn, and information in format, which is easier to be consumed by LLMS. Not yet de-facto standard. Before merging however, would probably be good to agree on a format.
Right now it just strips frontmatter (subject to change/discussion) MDX's imports and trims empty space at start and end of each Markdown file. As a minimum, probably, worth to include description from frontmatter in each section. (Using some AST manipulation would be much more effecient though probably)
More here :https://llmstxt.org/
Example in the wild: https://hono.dev/llms-full.txt, https://sdk.vercel.ai/llms.txt