chore: add llms.txt generation for LLM-friendly docs#39
Merged
Conversation
Generate llms.txt and llms-full.txt at docs build time following the llmstxt.org standard. The concise index links to API sections while the full file contains complete TypeScript type signatures for all 5 packages with an LLM agent instructions section. - Add scripts/generate-llms-txt.ts (reads versions from package.json) - Add static/robots.txt pointing sitemap to llms.txt - Update docs workflow to run generation + copy static files - Add docs:llms script to package.json
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
Add llms.txt standard support to the GitHub Pages documentation site, making couch-kit discoverable and consumable by LLM agents.
What's included
scripts/generate-llms-txt.ts— Bun script that generates both files at build time, reading package versions dynamically frompackages/*/package.jsonstatic/robots.txt— Allows all crawlers, points sitemap tollms.txt.github/workflows/docs.yml— Runs generation after TypeDoc and copies static files before deploydocs:llmsscript to rootpackage.jsonGenerated output
llms.txtllms-full.txtThe full file includes 11 sections covering all packages (
core,client,host,cli,devtools) with complete type signatures, usage examples, and an "Instructions for LLM Agents" section following the Stripe pattern.After merge, files will be accessible at:
https://faluciano.github.io/react-native-couch-kit/llms.txthttps://faluciano.github.io/react-native-couch-kit/llms-full.txthttps://faluciano.github.io/react-native-couch-kit/robots.txtNo changeset needed
This is a workflow/config-only change — no package source code was modified.