-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Description
Summary
Add llms.txt and llms-full.txt generation to the MkDocs docs build, following the llmstxt.org standard. This makes our documentation discoverable and consumable by LLMs and AI coding tools.
Motivation
llms.txtis an emerging standard (844k+ sites) for providing structured, LLM-friendly documentation- Major projects (Anthropic, Cloudflare, Stripe, LangChain) already ship it
- Our 161 docs pages across 7 packages are a perfect fit — the index gives LLMs a curated overview, while the full file gives deep context
Plan
Plugin: mkdocs-llmstxt (v0.5.0, by pawamoy)
- Renders HTML→Markdown so it correctly captures mkdocstrings-generated API docs
- Auto-discovers sections from existing MkDocs nav structure
Changes:
pyproject.toml— addmkdocs-llmstxt>=0.5to[dependency-groups] docsmkdocs.yml— addllmstxtplugin withmarkdown_descriptionandfull_output: llms-full.txt
Output:
/llms.txt— curated index with links + descriptions (< 10KB)/llms-full.txt— all 161 pages expanded inline (full content)
Both files auto-generated on every mkdocs build and served on the deployed site.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels