Skip to content

docs: generate llms.txt and llms-full.txt via mkdocs-llmstxt plugin#387

Merged
MaStr merged 3 commits into
mainfrom
docs/llmstxt-plugin
Jun 20, 2026
Merged

docs: generate llms.txt and llms-full.txt via mkdocs-llmstxt plugin#387
MaStr merged 3 commits into
mainfrom
docs/llmstxt-plugin

Conversation

@MaStr

@MaStr MaStr commented Jun 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds the mkdocs-llmstxt plugin which generates /llms.txt and /llms-full.txt automatically during each MkDocs build
  • llms.txt follows the llmstxt.org standard: project summary + curated links to all documentation pages with descriptions
  • llms-full.txt contains the full content of all linked pages expanded inline
  • Both files are served via GitHub Pages at https://mastr.github.io/batcontrol/llms.txt and .../llms-full.txt
  • Links to both files added to the docs index page

Changes

  • mkdocs.yml — plugin configured with project description and all doc sections
  • pyproject.tomlmkdocs-llmstxt added to [docs] optional dependencies
  • .github/workflows/docs.yml — plugin added to pip install step
  • docs/index.md — links to llms.txt and llms-full.txt added at the bottom

Test plan

  • CI docs build passes
  • After merge: https://mastr.github.io/batcontrol/llms.txt and llms-full.txt are reachable
  • Links on the docs index page resolve correctly

🤖 Generated with Claude Code

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>
Copilot AI review requested due to automatic review settings June 20, 2026 06:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 llmstxt MkDocs plugin to generate llms.txt and llms-full.txt during site builds.
  • Add mkdocs-llmstxt to the docs optional dependencies and install it in the GitHub Pages docs workflow.
  • Add homepage links pointing to the generated llms.txt and llms-full.txt outputs.

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.

Comment thread pyproject.toml
Comment thread .github/workflows/docs.yml Outdated
Comment thread docs/index.md Outdated
MaStr and others added 2 commits June 20, 2026 09:13
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>
Copilot AI review requested due to automatic review settings June 20, 2026 07:24
@MaStr MaStr merged commit 0ce9ff7 into main Jun 20, 2026
14 checks passed
@MaStr MaStr deleted the docs/llmstxt-plugin branch June 20, 2026 07:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread pyproject.toml
]
docs = [
"mkdocs-material>=9.5,<10",
"mkdocs-llmstxt>=0.5.0,<1.0; python_version >= '3.10'",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants