docs(config): split the configuration documentation into pages #1657
Conversation
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
bearomorphism
commented
Nov 19, 2025
bearomorphism
commented
Nov 19, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1657 +/- ##
==========================================
+ Coverage 97.33% 98.68% +1.34%
==========================================
Files 42 60 +18
Lines 2104 2656 +552
==========================================
+ Hits 2048 2621 +573
+ Misses 56 35 -21
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bearomorphism
commented
Nov 19, 2025
bearomorphism
requested review from
Lee-W,
noirbizarre and
woile
as code owners
bearomorphism
force-pushed
the
doc-config-2
branch
from
d2a6dbe to
92fdf20
Compare
Collaborator
Author
|
I need time to review and improve it. |
Lee-W
reviewed
Nov 19, 2025
4 tasks
bearomorphism
force-pushed
the
doc-config-2
branch
from
f1ac47b to
01c0409
Compare
Collaborator
Author
|
Now it is ready for review. I will probably use AI to improve the wording in the documentation in some future PRs. Let's improve the structure first. |
bearomorphism
force-pushed
the
doc-config-2
branch
from
01c0409 to
449ac4d
Compare
This was referenced Nov 21, 2025
Lee-W
reviewed
Nov 30, 2025
Lee-W
added
pr-status: wait-for-modification
and removed
pr-status: wait-for-review
labels
bearomorphism
force-pushed
the
doc-config-2
branch
2 times, most recently
from
54d9e58 to
2fa81c7
Compare
bearomorphism
commented
Nov 30, 2025
4 tasks
4 tasks
This was referenced Dec 4, 2025
bearomorphism
force-pushed
the
doc-config-2
branch
3 times, most recently
from
f72e500 to
0e95629
Compare
Collaborator
Author
|
Checked #1236 and moved the new content to |
Lee-W
approved these changes
Dec 10, 2025
Member
Lee-W
left a comment
Lee-W
left a comment
There was a problem hiding this comment.
A few nitpicks but nothing is actally blocking
This was referenced Dec 10, 2025
Co-authored-by: Wei Lee <weilee.rx@gmail.com>
bearomorphism
force-pushed
the
doc-config-2
branch
from
cfb3d02 to
8ab6f77
Compare
This was referenced Dec 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
docs/config.mdbasically mixed the usage of options that is only used by different cz commands together. It would be better if those options are categorized.Also, duplication of option usage documentation occurs. It should be fixed.
This PR categorized and centralizes those configuration file options, and remove the duplication of option usages.
The configuration file doc and version provider doc have their own pages now.
Checklist
Documentation Changes
poetry doclocally to ensure the documentation pages renders correctly