Skip to content

Commit 6eb50fb

Browse files
docs: switch llms.txt to mkdocs-llmstxt plugin
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>
1 parent d4a28e8 commit 6eb50fb

5 files changed

Lines changed: 1004 additions & 1016 deletions

File tree

SKILL.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

docs/llms.txt

Lines changed: 0 additions & 74 deletions
This file was deleted.

mkdocs.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,57 @@ markdown_extensions:
113113
plugins:
114114
- search
115115
- git-revision-date-localized
116+
- llmstxt:
117+
full_output: llms-full.txt
118+
markdown_description: >
119+
Commitizen is a release management tool for teams that enforce
120+
Conventional Commits, automate semantic versioning bumps, and
121+
generate changelogs. Start with the introduction for installation
122+
and core workflows, then use the command and configuration sections
123+
for day-to-day usage. Tutorials cover CI integration, commit hooks,
124+
monorepos, and release automation.
125+
sections:
126+
Overview:
127+
- README.md
128+
- faq.md: Answers to common setup and usage questions.
129+
- exit_codes.md: Reference for Commitizen CLI exit codes and failure modes.
130+
Commands:
131+
- commands/init.md: Initialize Commitizen configuration for a project.
132+
- commands/commit.md: Create standardized commits with the interactive prompt.
133+
- commands/bump.md: Calculate next version, update version files, and manage release tagging.
134+
- commands/check.md: Validate commit messages against the configured convention.
135+
- commands/changelog.md: Generate changelog entries from commits and tags.
136+
- commands/example.md: Show example commit messages for the configured rules.
137+
- commands/info.md: Show information about the active configuration.
138+
- commands/ls.md: List supported commit message choices for the active rules.
139+
- commands/schema.md: Show the commit message schema for the active convention.
140+
- commands/version.md: Show the installed or project version.
141+
Configuration:
142+
- config/configuration_file.md: Where configuration can live and how it is loaded.
143+
- config/option.md: Global options such as commit rules, version, and style.
144+
- config/bump.md: Version bumping, tag creation, and version-file update settings.
145+
- config/commit.md: Settings for interactive commit creation and prompts.
146+
- config/check.md: Settings for commit message validation.
147+
- config/changelog.md: Settings for changelog generation and formatting.
148+
- config/version_provider.md: How Commitizen reads and writes versions for different project types.
149+
Advanced Customization:
150+
- customization/config_file.md: Define custom commit and bump rules in project configuration.
151+
- customization/python_class.md: Implement a Python class for fully custom behavior.
152+
- customization/changelog_template.md: Customize changelog output templates.
153+
Tutorials:
154+
- tutorials/writing_commits.md: Writing effective Conventional Commits.
155+
- tutorials/tag_format.md: Configure and work with custom Git tag formats.
156+
- tutorials/auto_check.md: Enforce commit message checks automatically.
157+
- tutorials/auto_prepare_commit_message.md: Pre-fill commit messages before editing.
158+
- tutorials/gitlab_ci.md: Automate release workflows in GitLab CI.
159+
- tutorials/github_actions.md: Automate release workflows in GitHub Actions.
160+
- tutorials/jenkins_pipeline.md: Integrate Commitizen into Jenkins pipelines.
161+
- tutorials/dev_releases.md: Manage development and prerelease versioning.
162+
- tutorials/monorepo_guidance.md: Configure Commitizen for monorepos.
163+
Third-Party Plugins:
164+
- third-party-plugins/about.md: Overview of the plugin ecosystem.
165+
- third-party-plugins/*.md
166+
Contributing:
167+
- contributing/contributing_tldr.md: Fast path for setting up a local dev workflow.
168+
- contributing/contributing.md: Full contributor guide.
169+
- contributing/pull_request.md: Expectations for preparing and submitting PRs.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ dev = [
9797
"tox-uv",
9898
]
9999

100-
base = ["poethepoet>=0.34.0"]
100+
base = ["mkdocs-llmstxt>=0.5.0", "poethepoet>=0.34.0"]
101101

102102
test = [
103103
"pytest>=9",

0 commit comments

Comments
 (0)