docs: add llms.txt via mkdocs-llmstxt plugin#1948
Open
bearomorphism wants to merge 3 commits intomasterfrom
Open
docs: add llms.txt via mkdocs-llmstxt plugin#1948bearomorphism wants to merge 3 commits intomasterfrom
bearomorphism wants to merge 3 commits intomasterfrom
Conversation
Add docs/llms.txt to expose a structured, LLM-friendly index of the documentation site. No mkdocs configuration changes are required because MkDocs copies docs/llms.txt as a static asset, which was verified with uv run mkdocs build --strict. Refs #1936 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an llms.txt static asset to the MkDocs documentation site to provide an agent/LLM-friendly index of key Commitizen docs pages (grouped by topic), supporting discoverability for automated tooling.
Changes:
- Add
docs/llms.txtwith grouped, canonical links to major documentation sections (overview, commands, configuration, tutorials, plugins, contributing).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add a root-level SKILL.md that follows the Agent Skills specification and guides agents to Commitizen commands, configuration, versioning, changelog, CI, and exit-code references. Refs: #1936 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
12 tasks
Collaborator
Author
ValidationVerified that all review comments have been addressed:
Currently researching whether the file placement at |
Replace hand-crafted docs/llms.txt with the mkdocs-llmstxt plugin that auto-generates llms.txt and llms-full.txt from mkdocs.yml config. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Description
Add auto-generated
llms.txtandllms-full.txtfor the docs site using themkdocs-llmstxtplugin.Instead of a hand-crafted static file, the plugin auto-generates both files from
mkdocs.ymlon every build, keeping them in sync with docs automatically.llms-full.txtincludes expanded page contents for direct LLM consumption.Checklist
Was generative AI tooling used to co-author this PR?
Generated-by: GitHub Copilot CLI following the guidelines
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
After
mkdocs build, bothsite/llms.txt(index) andsite/llms-full.txt(expanded contents) are generated automatically from the mkdocs.yml plugin config.Steps to Test This Pull Request
uv run mkdocs build --strictsite/llms.txtandsite/llms-full.txtexistAdditional Context
Part of #1936. The SKILL.md portion is addressed in PR #1949.
Switched from a hand-crafted
docs/llms.txtto themkdocs-llmstxtplugin based on research showing that auto-generation keeps docs in sync and also produces the commonly-expectedllms-full.txtcompanion file.