Skip to content

docs: improve clarity of docs and fix typo/grammar issues #1404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
45148ae
docs: fix typos and grammar mistakes
bearomorphism May 11, 2025
09b0a45
docs: fix typo issues in cli.py, README.md, and contributing.md
bearomorphism May 11, 2025
c1b5ddb
docs(README.md): sync help section with the latest `cz --help` comman…
bearomorphism May 11, 2025
8878c45
docs(README.md): make it easier for readers to understand what Commit…
bearomorphism May 11, 2025
9549db5
docs(README.md): move Getting Started to README and improve clarity o…
bearomorphism May 11, 2025
2cba21a
docs(README.md): improve clarity of README reference section
bearomorphism May 11, 2025
299536e
docs(cli): align cli output with docs
bearomorphism May 11, 2025
aa0e7b6
docs(contributing.md): improve readability of contributing docs
bearomorphism May 11, 2025
2cda453
docs(pyproject.toml): fix typo
bearomorphism May 11, 2025
a7ae682
docs(README): update get project version section
bearomorphism May 12, 2025
0584e90
docs(README): update installation methods
bearomorphism May 14, 2025
a5ede8c
docs(README): use cli screenshots
bearomorphism May 15, 2025
cc45de4
docs: fix link warnings and minor grammar issues
bearomorphism May 15, 2025
5ea8026
docs(pull_request_template): add broken link check to the checklist
bearomorphism May 15, 2025
63787d3
docs(contributing): update codecov link
bearomorphism May 15, 2025
82a42c8
docs(README): update project specific installation methods
bearomorphism May 15, 2025
953e878
docs: capitalize commitizen for consistency
bearomorphism May 15, 2025
4e6e3ca
docs(README): update documentation site link text
bearomorphism May 18, 2025
9b99642
docs(README): replace internal links with documentation site link
bearomorphism May 18, 2025
361e977
docs(README): paraphase features
bearomorphism May 18, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ Please fill in the following content to let us know better about this change.
### Documentation Changes

- [ ] Run `poetry doc` locally to ensure the documentation pages renders correctly
- [ ] Check if there are any broken links in the documentation

> When running `poetry doc`, any broken internal documentation links will be reported in the console output like this:
>
> ```text
> INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.
> ```
## Expected Behavior
<!-- A clear and concise description of what you expected to happen -->
Expand Down
7 changes: 3 additions & 4 deletions commitizen/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,8 @@ def __call__(
data = {
"prog": "cz",
"description": (
"Commitizen is a cli tool to generate conventional commits.\n"
"For more information about the topic go to "
"https://conventionalcommits.org/"
"Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management.\n"
"For more information, please visit https://commitizen-tools.github.io/commitizen"
Copy link
Member

Choose a reason for hiding this comment

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

We definitively need to move the documentation to the root!

Copy link
Member

Choose a reason for hiding this comment

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

True 🤦‍♂️


@bearomorphism, not something you should fix, though. will need to be taken care by us

),
"formatter_class": argparse.RawDescriptionHelpFormatter,
"arguments": [
Expand All @@ -105,7 +104,7 @@ def __call__(
"name": ["-nr", "--no-raise"],
"type": str,
"required": False,
"help": "comma separated error codes that won't rise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
"help": "comma separated error codes that won't raise error, e.g: cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
},
],
"subcommands": {
Expand Down
Loading