docs: fix link warnings and minor grammar issues

Author: bearomorphism

docs/commands/bump.md

@@ -72,7 +72,7 @@ cz bump --changelog
 
 The bump is a pre-release bump, meaning that in addition to a possible version bump the new version receives a
 pre-release segment compatible with the bump’s version scheme, where the segment consist of a _phase_ and a
-non-negative number. Supported options for `--prerelease` are the following phase names  `alpha`, `beta`, or
+non-negative number. Supported options for `--prerelease` are the following phase names `alpha`, `beta`, or
 `rc` (release candidate). For more details, refer to the
 [Python Packaging User Guide](https://packaging.python.org/en/latest/specifications/version-specifiers/#pre-releases).
 
@@ -387,7 +387,7 @@ to skip and why.
 Remember to document somewhere this, because you'll forget.
 
 For example if the system raises a `NoneIncrementExit` error, you look it up
-on the list and then you can use the exit code:
+on the list, and then you can use the exit code:
 
 ```sh
 cz -nr 21 bump
@@ -403,7 +403,7 @@ These are used in:
 
 - `cz bump`: Find previous release tag (exact match) and generate new tag.
 - Find previous release tags in `cz changelog`.
-  - If `--incremental`: Using latest version found in the changelog, scan existing Git tags with 89\% similarity match.
+  - If `--incremental`: Using the latest version found in the changelog, scan existing Git tags with 89\% similarity match.
   - `--rev-range` is converted to Git tag names with `tag_format` before searching Git history.
 - If the `scm` `version_provider` is used, it uses different regexes to find the previous version tags:
   - If `tag_format` is set to `$version` (default): `VersionProtocol.parser` (allows `v` prefix)
@@ -477,7 +477,7 @@ in a line containing the `version` substring.
 
 Template used to specify the commit message generated when bumping.
 
-defaults to: `bump: version $current_version → $new_version`
+Defaults to: `bump: version $current_version → $new_version`
 
 | Variable           | Description                         |
 | ------------------ | ----------------------------------- |
@@ -499,7 +499,7 @@ bump_message = "release $current_version → $new_version [skip-ci]"
 
 When set to `true` the changelog is always updated incrementally when running `cz bump`, so the user does not have to provide the `--changelog` flag every time.
 
-defaults to: `false`
+Defaults to: `false`
 
 ```toml
 [tool.commitizen]

docs/config.md

@@ -59,7 +59,7 @@ Default: `[ ]`
 
 Legacy git tag formats, useful for old projects that changed tag format.
 Tags matching those formats will be recognized as version tags and be included in the changelog.
-Each entry use the the syntax as [`tag_format`](#tag_format). [Read more][tag_format]
+Each entry uses the syntax as [`tag_format`](#tag_format). [Read more][tag_format]
 
 ### `ignored_tag_formats`
 
@@ -68,7 +68,7 @@ Type: `list`
 Default: `[ ]`
 
 Tags matching those formats will be totally ignored and won't raise a warning.
-Each entry use the the syntax as [`tag_format`](#tag_format) with the addition of `*`
+Each entry uses the syntax as [`tag_format`](#tag_format) with the addition of `*`
 that will match everything (non-greedy). [Read more][tag_format]
 
 ### `update_changelog_on_bump`
@@ -101,7 +101,7 @@ Type: `str`
 
 Default: `None`
 
-Create custom commit message, useful to skip ci. [Read more][bump_message]
+Create custom commit message, useful to skip CI. [Read more][bump_message]
 
 ### `retry_after_failure`
 
@@ -117,7 +117,7 @@ Type: `bool`
 
 Default: `false`
 
-Disallow empty commit messages, useful in ci. [Read more][allow_abort]
+Disallow empty commit messages, useful in CI. [Read more][allow_abort]
 
 ### `allowed_prefixes`
 
@@ -195,15 +195,15 @@ Type: `bool`
 
 Default: `false`
 
-When true, breaking changes on a `0.x` will remain as a `0.x` version. On `false`, a breaking change will bump a `0.x` version to `1.0`. [major-version-zero]
+When true, breaking changes on a `0.x` will remain as a `0.x` version. On `false`, a breaking change will bump a `0.x` version to `1.0`. [Read more][major-version-zero]
 
 ### `prerelease_offset`
 
 Type: `int`
 
 Default: `0`
 
-In some circumstances, a prerelease cannot start with a 0, e.g. in an embedded project individual characters are encoded as bytes. This can be done by specifying an offset from which to start counting. [prerelease-offset]
+In some circumstances, a prerelease cannot start with a 0, e.g. in an embedded project individual characters are encoded as bytes. This can be done by specifying an offset from which to start counting. [Read more][prerelease-offset]
 
 ### `pre_bump_hooks`
 
@@ -247,7 +247,7 @@ Provide extra variables to the changelog template. [Read more][template-customiz
 
 ## Configuration file
 
-### pyproject.toml, .cz.toml or cz.toml
+### `pyproject.toml`, `.cz.toml` or `cz.toml`
 
 Default and recommended configuration format for a project.
 For a **python** project, we recommend adding an entry to your `pyproject.toml`.
@@ -278,7 +278,7 @@ style = [
 ]
 ```
 
-### .cz.json or cz.json
+### `.cz.json` or `cz.json`
 
 Commitizen has support for JSON configuration. Recommended for `NodeJS` projects.
 
@@ -304,7 +304,7 @@ Commitizen has support for JSON configuration. Recommended for `NodeJS` projects
 }
 ```
 
-### .cz.yaml or cz.yaml
+### `.cz.yaml` or `cz.yaml`
 
 YAML configuration is supported by Commitizen. Recommended for `Go`, `ansible`, or even `helm` charts projects.
 
@@ -358,7 +358,7 @@ Commitizen provides some version providers for some well known formats:
 | `composer`   | Get and set version from `composer.json` `project.version` field                                                                                                                                                        |
 
 !!! note
-The `scm` provider is meant to be used with `setuptools-scm` or any packager `*-scm` plugin.
+    The `scm` provider is meant to be used with `setuptools-scm` or any packager `*-scm` plugin.
 
 An example in your `.cz.toml` or `cz.toml` would look like this:
 
@@ -408,10 +408,10 @@ setup(
 [tag_format]: commands/bump.md#tag_format
 [bump_message]: commands/bump.md#bump_message
 [major-version-zero]: commands/bump.md#-major-version-zero
-[prerelease-offset]: commands/bump.md#-prerelease_offset
+[prerelease-offset]: commands/bump.md#prerelease_offset
 [retry_after_failure]: commands/commit.md#retry
 [allow_abort]: commands/check.md#allow-abort
-[version-scheme]: commands/bump.md#version-scheme
+[version-scheme]: commands/bump.md#-version-scheme
 [pre_bump_hooks]: commands/bump.md#pre_bump_hooks
 [post_bump_hooks]: commands/bump.md#post_bump_hooks
 [allowed_prefixes]: commands/check.md#allowed-prefixes

docs/customization.md

@@ -490,7 +490,7 @@ Users can provide their own template from their current working directory (your
 - setting your template path as `template` configuration
 - giving your template path as `--template` parameter to `bump` and `changelog` commands
 
-!!! Note
+!!! note
     The path is relative to the current working directory, aka your project root most of the time.
 
 ### Template variables
@@ -514,7 +514,7 @@ Each `Change` has the following fields:
 | author | `str` | The commit author name |
 | author_email | `str` | The commit author email |
 
-!!! Note
+!!! note
     The field values depend on the customization class and/or the settings you provide
 
 The `parents` field can be used to identify merge commits and generate a changelog based on those. Another use case

docs/tutorials/github_actions.md

@@ -41,14 +41,14 @@ jobs:
 
 Push to master and that's it.
 
-### Creating a github release
+### Creating a GitHub release
 
 You can modify the previous action.
 
 Add the variable `changelog_increment_filename` in the `commitizen-action`, specifying
 where to output the content of the changelog for the newly created version.
 
-And then add a step using a github action to create the release: `softprops/action-gh-release`
+And then add a step using a GitHub action to create the release: `softprops/action-gh-release`
 
 The commitizen action creates an env variable called `REVISION`, containing the
 newly created version.

docs/tutorials/gitlab_ci.md

@@ -12,9 +12,9 @@ _Goal_: Bump a new version every time that a change occurs on the `master` branc
 4. For simplification, we store the software version in a file called `VERSION`. You can use any file that you want as `commitizen` supports it.
 5. The commit message executed automatically by the `CI` must include `[skip-ci]` in the message; otherwise, the process will generate a loop. You can define the message structure in [commitizen](../commands/bump.md) as well.
 
-### Gitlab Configuration
+### GitLab Configuration
 
-To be able to change files and push new changes with `Gitlab CI` runners, we need to have a `ssh` key and configure a git user.
+To be able to change files and push new changes with `GitLab CI` runners, we need to have a `ssh` key and configure a git user.
 
 First, let's create a `ssh key`. The only requirement is to create it without a passphrase:
 

docs/tutorials/jenkins_pipeline.md

@@ -47,7 +47,7 @@ def useCz(String authorName = 'Jenkins CI Server', String authorEmail = 'your-je
 ```
 
 !!! warning
-    Using jenkins pipeline with any git plugin may require many different configurations,
+    Using jenkins pipeline with any git plugin may require many configurations,
     you'll have to tinker with it until your pipelines properly detects git events. Check your
     webhook in your git repository and check the "behaviors" and "build strategies" in
     your pipeline settings.

docs/tutorials/monorepo_guidance.md

@@ -56,9 +56,9 @@ In order to filter the correct commits for each component, you'll have to come u
 For example:
 
 - Trigger the pipeline based on the changed path, which can have some downsides, as you'll rely on the developer not including files from other files
-    - [github actions](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore) uses `path`
+    - [GitHub actions](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore) uses `path`
     - [Jenkins](https://www.jenkins.io/doc/book/pipeline/syntax/#built-in-conditions) uses `changeset`
-    - [Gitlab](https://docs.gitlab.com/ee/ci/yaml/#ruleschanges) uses `rules:changes`
+    - [GitLab](https://docs.gitlab.com/ee/ci/yaml/#ruleschanges) uses `rules:changes`
 - Filter certain pattern of the commit message (recommended)