Skip to content

Fix/docs#1924

Open
woile wants to merge 4 commits intomasterfrom
fix/docs
Open

Fix/docs#1924
woile wants to merge 4 commits intomasterfrom
fix/docs

Conversation

@woile
Copy link
Copy Markdown
Member

@woile woile commented Apr 5, 2026

Description

  • Closes Broken docs #1922
  • Improves readability of docs
  • Recommend semver2 during init (if not python)

Checklist

Was generative AI tooling used to co-author this PR?

NO

Code Changes

  • Add test cases to all the changes you introduce
  • 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

Steps to Test This Pull Request

For the init:

  1. Create new folder with mkdir -p /tmp/app && cd /tmp/app
  2. cz init
  3. Observe

Additional Context

cz bump --yes
```

### `--version-scheme`
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved it to the bottom, to have a cohesive view of the cli options.

Eventually, version-scheme should have it's own section, where the differences between pep440 and semver are explained.

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.99%. Comparing base (7c21c21) to head (f629d1e).
⚠️ Report is 3 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1924   +/-   ##
=======================================
  Coverage   97.99%   97.99%           
=======================================
  Files          60       60           
  Lines        2689     2691    +2     
=======================================
+ Hits         2635     2637    +2     
  Misses         54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@woile woile requested a review from bearomorphism April 5, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken docs

1 participant