docs(config): split the configuration documentation into pages #1657
Conversation
There was a problem hiding this comment.
Regenerated by AI, need to review correctness
There was a problem hiding this comment.
regenerated by AI
There was a problem hiding this comment.
also need to review correctness
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:
|
d2a6dbe to
92fdf20
Compare
|
I need time to review and improve it. |
docs/config/configuration_file.md
Outdated
|
|
||
| ## Creating a Configuration File | ||
|
|
||
| You can create a configuration file manually, or use Commitizen's interactive init command: |
There was a problem hiding this comment.
| You can create a configuration file manually, or use Commitizen's interactive init command: | |
| You can create a configuration file manually, or use Commitizen's interactive `init` command: |
There was a problem hiding this comment.
or
| You can create a configuration file manually, or use Commitizen's interactive init command: | |
| You can create a configuration file manually, or use Commitizen's interactive initialization command: |
There was a problem hiding this comment.
or just remove the init
or "It is recommended to create a configuration file via our cz init command." and add a link to init documentation
There was a problem hiding this comment.
or "It is recommended to create a configuration file via our cz init command." and add a link to init documentation
This is also good
| version = "0.1.0" # Managed by Commitizen | ||
| ``` | ||
|
|
||
| ### `poetry` |
There was a problem hiding this comment.
I think this only make sense for poetry < 2.0. for poetry >= 2.0, pep621 is suggested
There was a problem hiding this comment.
Could you provide details or suggested changes? Thanks!
|
|
||
| ### `uv` | ||
|
|
||
| Manages version in both `pyproject.toml` (`project.version`) and `uv.lock` (`package.version` for the matching package name). This ensures consistency between your project metadata and lock file. |
There was a problem hiding this comment.
It basically follows PEP621, would be better if we mention that
There was a problem hiding this comment.
Could you provide suggested changes? Thanks
| @@ -0,0 +1,308 @@ | |||
| # Version Providers | |||
There was a problem hiding this comment.
Out of topic: I think we'll need to make these version providers separate providers / python package at some point
There was a problem hiding this comment.
You can create a ticket to keep track of this issue. I am not familiar with the mechanism of version providers actually
f1ac47b to
01c0409
Compare
|
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. |
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