feat: add focused LLM slice files (llms-api.txt, llms-node-ops.txt)#802
Open
crtahlin wants to merge 3 commits into
Open
feat: add focused LLM slice files (llms-api.txt, llms-node-ops.txt)#802crtahlin wants to merge 3 commits into
crtahlin wants to merge 3 commits into
Conversation
Add two task-specific documentation bundles via docusaurus-plugin-llms customLLMFiles, so AI agents can load only the docs relevant to their task instead of the full 630KB llms-full.txt: - llms-api.txt (220KB, 20 docs): API usage, uploads, stamps, feeds, chunks, encryption, developer tooling - llms-node-ops.txt (225KB, 22 docs): installation, configuration, monitoring, staking, backups, upgrades, FAQ Both use glob patterns so new pages added under those directories are automatically included — no manual maintenance needed. Also adds slice file references to static/llms.txt for agent discovery, and extends the validation script to log referenced slice files. Refs: ethersphere/DevRel#840
✅ Deploy Preview for test-twitter-preview-testing-3 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.
Summary
Adds two task-specific documentation bundles so AI coding agents can load only what's relevant instead of the full 630KB
llms-full.txt:llms-api.txt(220KB, 20 docs) — API usage, uploads, stamps, feeds, chunks, encryption, developer toolingllms-node-ops.txt(225KB, 22 docs) — installation, configuration, monitoring, staking, backups, upgrades, FAQUses
docusaurus-plugin-llmscustomLLMFiles— glob patterns auto-include new pages, no manual maintenance.Also adds discovery links in
static/llms.txtand extends the validation script.Refs: ethersphere/DevRel#840
Maintenance
docs/develop/ordocs/bee/installation/are automatically includedscripts/validate-llms-txt.mjslogs referenced slice filesTest plan
npm run buildsucceeds — both files generatedllms-api.txt: 20 documents, correct header/rootContentllms-node-ops.txt: 22 documents, correct header/rootContentstatic/llms.txtreferences both slices