Title: docs: add llms.txt via mkdocs-llmstxt plugin by bearomorphism · Pull Request #1948 · commitizen-tools/commitizen · GitHub
Open Graph Title: docs: add llms.txt via mkdocs-llmstxt plugin by bearomorphism · Pull Request #1948 · commitizen-tools/commitizen
X Title: docs: add llms.txt via mkdocs-llmstxt plugin by bearomorphism · Pull Request #1948 · commitizen-tools/commitizen
Description: Description Add auto-generated llms.txt and llms-full.txt for the docs site using the mkdocs-llmstxt plugin. Instead of a hand-crafted static file, the plugin auto-generates both files from mkdocs.yml on every build, keeping them in sync with docs automatically. llms-full.txt includes expanded page contents for direct LLM consumption. Checklist I have read the contributing guidelines Was generative AI tooling used to co-author this PR? Yes (GitHub Copilot CLI) Generated-by: GitHub Copilot CLI following the guidelines Code Changes Add test cases to all the changes you introduce (N/A - docs config only) Run uv run poe all locally to ensure this change passes linter check and tests Manually test the changes: Verify the feature/bug fix works as expected in real-world scenarios Test edge cases and error conditions Ensure backward compatibility is maintained Document any manual testing steps performed Update the documentation for the changes Documentation Changes Run uv run poe doc locally to ensure the documentation pages renders correctly Check and fix any broken links (internal or external) Expected Behavior After mkdocs build, both site/llms.txt (index) and site/llms-full.txt (expanded contents) are generated automatically from the mkdocs.yml plugin config. Steps to Test This Pull Request Run uv run mkdocs build --strict Verify site/llms.txt and site/llms-full.txt exist Check that llms.txt contains grouped links matching the mkdocs.yml nav Additional Context Part of #1936. The SKILL.md portion is addressed in PR #1949. Switched from a hand-crafted docs/llms.txt to the mkdocs-llmstxt plugin based on research showing that auto-generation keeps docs in sync and also produces the commonly-expected llms-full.txt companion file.
Open Graph Description: Description Add auto-generated llms.txt and llms-full.txt for the docs site using the mkdocs-llmstxt plugin. Instead of a hand-crafted static file, the plugin auto-generates both files from mkdocs....
X Description: Description Add auto-generated llms.txt and llms-full.txt for the docs site using the mkdocs-llmstxt plugin. Instead of a hand-crafted static file, the plugin auto-generates both files from mkdocs....
Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1948
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:898d6fd8-5f5b-b76c-4a84-528904afc505 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | BE04:162B2:9EA3F0:DF1F62:6A4E82FE |
| html-safe-nonce | 9c3dd48ddc6fca832522c9b0dd452e4d35c19b7adadf652a11ea3b5277ded144 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCRTA0OjE2MkIyOjlFQTNGMDpERjFGNjI6NkE0RTgyRkUiLCJ2aXNpdG9yX2lkIjoiMjIxMDM1ODkyNTg2NTE1NzM3NCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 64411a328a075575b7f70c49f05d091347abe58405570c6ae40eb7735d3dbc7b |
| hovercard-subject-tag | pull_request:3641998219 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/commitizen-tools/commitizen/pull/1948/files |
| twitter:image | https://avatars.githubusercontent.com/u/26526132?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/26526132?s=400&v=4 |
| og:image:alt | Description Add auto-generated llms.txt and llms-full.txt for the docs site using the mkdocs-llmstxt plugin. Instead of a hand-crafted static file, the plugin auto-generates both files from mkdocs.... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 41b6ab3ba6d20a71766ac245b5a4a94c6fc672a9cd4da7d44c1b33ab8bf6a21c |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/commitizen-tools/commitizen git https://github.com/commitizen-tools/commitizen.git |
| octolytics-dimension-user_id | 62252524 |
| octolytics-dimension-user_login | commitizen-tools |
| octolytics-dimension-repository_id | 106127589 |
| octolytics-dimension-repository_nwo | commitizen-tools/commitizen |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 106127589 |
| octolytics-dimension-repository_network_root_nwo | commitizen-tools/commitizen |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | e6a744804e8e70f97b4d5a18a94dcc63db22f97a |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width