Repository navigation
feat: publish llms.txt from the Docusaurus build - #475
Merged
Merged
Conversation
Generate /llms.txt and /llms-full.txt during the production build so agents can read the community docs, and document that setup. Signed-off-by: Juan Estrella <juan.estrella@finos.org>
✅ Deploy Preview for eager-borg-83c1a5 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Added AI-readable documentation links to README.
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.
Summary
/llms.txtand/llms-full.txtduring the production build so agents can read the community docs as plain text.docusaurus-plugin-llms0.6.1 in the Docusaurus config. Docs live outsidewebsite/, so the plugin points at../docswith route base pathdocs, andexcludeImportsdrops MDX import lines from the generated text.useBaseUrllinks are flattened, and directory-relative links inside/llms-full.txtdo not resolve.These files are documentation. They are not an MCP server.
Test plan
website/, runyarn buildand confirmbuild/llms.txtandbuild/llms-full.txtare written./llms.txtlists documentation pages and that its links use the siteurlfrom the Docusaurus config.useBaseUrland a directory-relative link, and confirm/llms-full.txtkeeps the visible text while those URLs behave as documented.