docs: fix broken commitizen documentation links - #112
Open
bearomorphism wants to merge 1 commit into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
The cz-conf and cz-custom reference links in README.md pointed to URL paths that no longer exist on the commitizen documentation site: - https://commitizen-tools.github.io/commitizen/config/ -> 404 - https://commitizen-tools.github.io/commitizen/customization/ -> 404 The corresponding pages have moved to: - https://commitizen-tools.github.io/commitizen/config/configuration_file/ - https://commitizen-tools.github.io/commitizen/customization/config_file/ Closes commitizen-tools#106 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced May 10, 2026
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
1 participant
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.
Why
Two reference link definitions in README.md point to URL paths that
no longer exist on the commitizen documentation site:
Both are linked from the README body (the commitizen's configuration page link in the Minimal configuration section, and the Read more
about customization link near the end), so users currently land on
404 pages.
What
Update the link definitions to the new locations on the docs site:
How
The pages were renamed when the commitizen docs were reorganised into
sub-pages per topic. The new URLs point to the equivalent content
(configuration file format, and the customisation guide).
Verification
Invoke-WebRequest -Method Head against the new and old URLs:
The new URLs are also referenced from the live commitizen docs
home page (e.g. [Customizable](.../customization/config_file/)),
confirming they are the canonical replacements.
Closes #106