rename

Author: bearomorphism

docs/commands/init.md

@@ -1,4 +1,4 @@
-The `cz init` command helps you set up Commitizen in your project by creating a configuration file with your preferred settings.
+The `cz init` command helps you set up Commitizen in your project by creating a configuration_file with your preferred settings.
 
 ## Usage
 
@@ -20,10 +20,7 @@ When you run `cz init`, Commitizen will guide you through an interactive setup p
 
 The initialization process will create a configuration file in your project root.
 
-Choose the configuration file format based on your project type:
-
-- Use `pyproject.toml` for Python projects
-- Use `.cz.toml`, `.cz.yaml`, `.cz.json`, etc. for other projects.
+See [Configuration File][configuration_file] for more details.
 
 ## Configuration Options
 
@@ -48,6 +45,8 @@ During the initialization process, you'll be prompted to configure the following
 7. **Alpha Versioning**: Option to keep major version at 0 for alpha/beta software
 8. **Pre-commit Hooks**: Set up Git pre-commit hooks for automated commit message validation
 
+See [Configuration Options][configuration_options] for more details.
+
 ## Example
 
 ```sh
@@ -61,6 +60,9 @@ cz init
 
 After initialization, you can:
 
-1. Start using `cz commit` to create conventional commits
-2. Use `cz bump` to manage versioning
-3. Configure additional settings in your project's configuration file
+1. Start using [`cz commit`](./commit.md) to create conventional commits
+2. Use [`cz bump`](./bump.md) to manage versioning
+3. Configure additional settings in your project's [configuration_file][configuration_file]
+
+[configuration_file]: ../config/configuration_file.md
+[configuration_options]: ../config/option.md

docs/config/configuration_file.md

@@ -4,13 +4,7 @@ Commitizen uses configuration files to customize its behavior for your project.
 
 ## Creating a Configuration File
 
-You can create a configuration file manually, or use Commitizen's interactive init command:
-
-```bash
-cz init
-```
-
-This command will guide you through setting up your configuration file with the appropriate settings for your project.
+It is recommended to create a configuration file via our [`cz init`](../commands/init.md) command. This command will guide you through setting up your configuration file with the appropriate settings for your project.
 
 ## File Location and Search Order
 
@@ -34,8 +28,8 @@ The first valid configuration file found will be used. If no configuration file
 Commitizen supports three configuration file formats:
 
 - **TOML** (`.toml`) - Recommended for Python projects
-- **JSON** (`.json`) - Recommended for Node.js projects
-- **YAML** (`.yaml`) - Recommended for Go, Ansible, or Helm chart projects
+- **JSON** (`.json`)
+- **YAML** (`.yaml`)
 
 All formats support the same configuration options. Choose the format that best fits your project's ecosystem.
 
@@ -220,7 +214,7 @@ commitizen:
 
 ## Configuration Options
 
-For a complete list of all available configuration options and their descriptions, see the [Configuration Settings](../config/settings.md) documentation.
+For a complete list of all available configuration options and their descriptions, see the [Configuration Settings](../config/option.md) documentation.
 
 Key configuration categories include:
 

docs/config/settings.md renamed to docs/config/option.md

@@ -1,4 +1,4 @@
-# Settings
+# Configuration Options
 
 TODO: categorize the following settings into bump, commit, check, changelog, etc.
 

docs/customization.md

@@ -184,7 +184,7 @@ commitizen:
 
 #### Shortcut keys
 
-When the [`use_shortcuts`](./config/settings.md#use_shortcuts) config option is enabled, Commitizen can show and use keyboard shortcuts to select items from lists directly.
+When the [`use_shortcuts`](./config/option.md#use_shortcuts) config option is enabled, Commitizen can show and use keyboard shortcuts to select items from lists directly.
 For example, when using the `cz_conventional_commits` Commitizen template, shortcut keys are shown when selecting the commit type. Unless otherwise defined, keyboard shortcuts will be numbered automatically.
 To specify keyboard shortcuts for your custom choices, provide the shortcut using the `key` parameter in dictionary form for each choice you would like to customize.
 
@@ -524,6 +524,6 @@ by:
 - defining them in your configuration with the [`extras` settings][extras-config]
 - providing them on the command line with the `--extra/-e` parameter to `bump` and `changelog` commands
 
-[template-config]: config/settings.md#template
-[extras-config]: config/settings.md#extras
+[template-config]: config/option.md#template
+[extras-config]: config/option.md#extras
 [changelog-des]: ./commands/changelog.md#description

docs/faq.md

@@ -132,7 +132,7 @@ If you would like to learn more about both schemes, there are plenty of good res
 
 ## How to change the tag format ?
 
-You can use the [`legacy_tag_formats`](config/settings.md#legacy_tag_formats) to list old tag formats.
+You can use the [`legacy_tag_formats`](config/option.md#legacy_tag_formats) to list old tag formats.
 New bumped tags will be in the new format but old ones will still work for:
 - changelog generation (full, incremental and version range)
 - bump new version computation (automatically guessed or increment given)
@@ -151,7 +151,7 @@ legacy_tag_formats = [
 
 ## How to avoid warnings for expected non-version tags
 
-You can explicitly ignore them with [`ignored_tag_formats`](config/settings.md#ignored_tag_formats).
+You can explicitly ignore them with [`ignored_tag_formats`](config/option.md#ignored_tag_formats).
 
 ```toml
 tag_format = "v${version}"

docs/tutorials/tag_format.md

@@ -43,7 +43,7 @@ As a result, the tag generated on bump will have this format: `v1.0.0` and the v
     Both `$version` and `${version}` syntaxes are strictly equivalent. You can use the one you prefer.
 
 See [the `version_scheme` section in `bump` command documentation](../commands/bump.md#version_scheme) for more details on version schemes and how to define your own.
-See [`tag_format`](../config/settings.md#tag_format) and [`version_scheme`](../config/settings.md#version_scheme) settings in [Configuration reference](../config/settings.md) for more details on these settings.
+See [`tag_format`](../config/option.md#tag_format) and [`version_scheme`](../config/option.md#version_scheme) settings in [Configuration reference](../config/option.md) for more details on these settings.
 
 ## Changing convention
 
@@ -71,7 +71,7 @@ Your new tag will be in the form `component-${version}`.
 Now let's say you have some known tags you want to ignore, either because they are not versions, or because they are not versions of the component you are dealing with.
 As a consequence, you don't want them to trigger a warning because Commitizen detected an unknown tag format.
 
-Then you can tell Commitizen about it using the [`ignored_tag_formats`](../config/settings.md#ignored_tag_formats) setting:
+Then you can tell Commitizen about it using the [`ignored_tag_formats`](../config/option.md#ignored_tag_formats) setting:
 
 ```yaml
 [tool.commitizen]

docs/tutorials/writing_commits.md

@@ -47,5 +47,5 @@ Emojis may be added as well (e.g., see [cz-emoji][cz_emoji]), which requires the
 [customization]: ../customization.md
 [conventional_commits]: https://www.conventionalcommits.org
 [cz_emoji]: https://commitizen-tools.github.io/commitizen/third-party-commitizen/#cz-emoji
-[configuration]: ../config/settings.md#encoding
-[breaking-change-config]: ../config/settings.md#breaking_change_exclamation_in_title
+[configuration]: ../config/option.md#encoding
+[breaking-change-config]: ../config/option.md#breaking_change_exclamation_in_title

mkdocs.yml

@@ -45,7 +45,7 @@ nav:
   - Configuration:
       - Configuration File: "config/configuration_file.md"
       - Version Provider: "config/version_provider.md"
-      - Settings: "config/settings.md"
+      - Settings: "config/option.md"
   - Customization: "customization.md"
   - Tutorials:
       - Writing commits: "tutorials/writing_commits.md"