docs: generate llms.txt and llms-full.txt via mkdocs-llmstxt plugin#387
Merged
Conversation
Adds the mkdocs-llmstxt plugin which generates /llms.txt and /llms-full.txt at build time from the existing documentation pages. Both files are served via GitHub Pages and linked from the docs index. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR integrates the mkdocs-llmstxt MkDocs plugin into the documentation build so the published GitHub Pages site automatically exposes /llms.txt and /llms-full.txt for LLM-friendly consumption, and adds links to those artifacts from the docs homepage.
Changes:
- Add and configure the
llmstxtMkDocs plugin to generatellms.txtandllms-full.txtduring site builds. - Add
mkdocs-llmstxtto the docs optional dependencies and install it in the GitHub Pages docs workflow. - Add homepage links pointing to the generated
llms.txtandllms-full.txtoutputs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
pyproject.toml |
Adds mkdocs-llmstxt to the [docs] optional dependency set. |
mkdocs.yml |
Configures the llmstxt plugin (description, sections, and full output). |
docs/index.md |
Adds links to the generated LLM-oriented documentation artifacts. |
.github/workflows/docs.yml |
Installs the plugin during the Pages build so mkdocs build can run with the new config. |
mkdocs-llmstxt 0.5.0 requires Python >=3.10 but the project declares requires-python >3.8. uv resolves all extras for the full version range, causing the dependency to be unsatisfiable for 3.8/3.9 splits even when only [test] is installed. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Add upper version bound <1.0 to mkdocs-llmstxt in pyproject.toml and docs.yml - Use absolute GitHub Pages URLs for llms.txt/llms-full.txt links in index.md to avoid MkDocs strict-mode failures (files are generated post-build and unknown to the link validator) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
| ] | ||
| docs = [ | ||
| "mkdocs-material>=9.5,<10", | ||
| "mkdocs-llmstxt>=0.5.0,<1.0; python_version >= '3.10'", |
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
mkdocs-llmstxtplugin which generates/llms.txtand/llms-full.txtautomatically during each MkDocs buildllms.txtfollows the llmstxt.org standard: project summary + curated links to all documentation pages with descriptionsllms-full.txtcontains the full content of all linked pages expanded inlinehttps://mastr.github.io/batcontrol/llms.txtand.../llms-full.txtChanges
mkdocs.yml— plugin configured with project description and all doc sectionspyproject.toml—mkdocs-llmstxtadded to[docs]optional dependencies.github/workflows/docs.yml— plugin added to pip install stepdocs/index.md— links tollms.txtandllms-full.txtadded at the bottomTest plan
https://mastr.github.io/batcontrol/llms.txtandllms-full.txtare reachable🤖 Generated with Claude Code