feat: Generate llms.txt for AI agents#869
Open
lfrancke wants to merge 1 commit into
Open
Conversation
A new Antora extension emits /llms.txt (https://llmstxt.org/) at build time. It indexes every page of the version that 'stable' points to, with the page description and a link to the AsciiDoc source on GitHub, and cross-links the machine-readable release/CRD data on the Stackable Hub. This gives AI agents a way to discover and navigate the docs without scraping HTML, and to locate the source file behind any page.
✅ Deploy Preview for stackable-docs 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
1 participant
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.
Description
Adds an Antora extension that emits
/llms.txtat build time.It gives AI agents a machine-readable entry point to the docs:
stablepoints to (the latest release; nightly in dev builds), grouped by module, with page descriptions from the:description:attributeThis is not perfect yet and we can do more later (e.g. a ".md" file next to each normal docs page so agents don't have to read all that HTML stuff" or a llms-full.txt which we might be able to use in the OpenSearch RAG demo) but that's separate.