docs: add cross-references to CLI reference documentation in various markdown files (#2678)

koxudaxi · web-flow · commit c8f8744d6ca1 · 2025-12-18T10:25:41.000+09:00
diff --git a/docs/aliases.md b/docs/aliases.md
@@ -107,3 +107,7 @@ class Root(BaseModel):
 - The `ClassName` in scoped format must match the generated Python class name (after title conversion)
 - When using `--use-title-as-name`, the class name is derived from the `title` property in the schema
 - Aliases are applied during code generation, so the original field names are preserved as Pydantic `alias` values for proper serialization/deserialization
+
+## See Also
+
+- [CLI Reference: `--aliases`](cli-reference/field-customization.md#aliases) - Detailed CLI option documentation with examples
diff --git a/docs/cli-reference/field-customization.md b/docs/cli-reference/field-customization.md
@@ -34,6 +34,9 @@ Apply custom field and class name aliases from JSON file.
 The `--aliases` option allows renaming fields and classes via a JSON mapping file,
 providing fine-grained control over generated names independent of schema definitions.
 
+!!! tip "See Also"
+    For detailed explanation and examples, see [Field Aliases](../aliases.md).
+
 !!! tip "Usage"
 
     ```bash
@@ -853,6 +856,9 @@ The `--field-constraints` flag generates Pydantic Field() definitions with
 validation constraints (min/max length, pattern, etc.) from the schema.
 Output differs between Pydantic v1 and v2 due to API changes.
 
+!!! tip "See Also"
+    For detailed explanation and mypy compatibility, see [Field Constraints](../field-constraints.md).
+
 !!! tip "Usage"
 
     ```bash
diff --git a/docs/cli-reference/general-options.md b/docs/cli-reference/general-options.md
@@ -1389,6 +1389,9 @@ The `--generate-pyproject-config` flag outputs a pyproject.toml configuration
 snippet based on the provided CLI arguments. This is useful for converting
 a working CLI command into a reusable configuration file.
 
+!!! tip "See Also"
+    For pyproject.toml configuration guide, see [pyproject.toml Configuration](../pyproject_toml.md).
+
 !!! tip "Usage"
 
     ```bash
@@ -1595,6 +1598,9 @@ The `--ignore-pyproject` flag tells datamodel-codegen to ignore any
 when you want to override project defaults with CLI arguments, or when
 testing without project configuration.
 
+!!! tip "See Also"
+    For pyproject.toml configuration guide, see [pyproject.toml Configuration](../pyproject_toml.md).
+
 !!! tip "Usage"
 
     ```bash
diff --git a/docs/cli-reference/index.md b/docs/cli-reference/index.md
@@ -4,6 +4,18 @@ This documentation is auto-generated from test cases.
 
 **[Quick Reference](quick-reference.md)** - All options on one page for Ctrl+F search
 
+## Related Documentation
+
+| Topic | Description |
+|-------|-------------|
+| [Generate from OpenAPI](../openapi.md) | OpenAPI schema generation guide |
+| [Generate from JSON Schema](../jsonschema.md) | JSON Schema generation guide |
+| [Generate from GraphQL](../graphql.md) | GraphQL schema generation guide |
+| [pyproject.toml Configuration](../pyproject_toml.md) | File-based configuration |
+| [Custom Templates](../custom_template.md) | Jinja2 template customization |
+| [Field Aliases](../aliases.md) | Field renaming with aliases |
+| [Root Models and Type Aliases](../root-model-and-type-alias.md) | Type alias generation |
+
 ## Categories
 
 | Category | Options | Description |
diff --git a/docs/cli-reference/openapi-only-options.md b/docs/cli-reference/openapi-only-options.md
@@ -1,5 +1,8 @@
 # OpenAPI-only Options
 
+!!! info "Related Documentation"
+    For OpenAPI usage guide and examples, see [Generate from OpenAPI](../openapi.md).
+
 ## Options
 
 | Option | Description |
diff --git a/docs/cli-reference/template-customization.md b/docs/cli-reference/template-customization.md
@@ -471,6 +471,9 @@ as a module path (e.g., "mymodule.formatter_function"). This is useful for
 adding custom comments, modifying code structure, or applying project-specific
 formatting rules beyond what black/isort provide.
 
+!!! tip "See Also"
+    For detailed explanation and examples, see [Custom Code Formatters](../custom-formatters.md).
+
 !!! tip "Usage"
 
     ```bash
@@ -605,6 +608,9 @@ to override the default templates used for generating data models. This enables
 the generated code structure and formatting. Use with `--extra-template-data` to pass additional data
 to the templates.
 
+!!! tip "See Also"
+    For detailed explanation and examples, see [Custom Templates](../custom_template.md).
+
 !!! tip "Usage"
 
     ```bash
@@ -1921,6 +1927,9 @@ the generated Python code. Available formatters are: black, isort,
 ruff, yapf, autopep8, autoflake. Default is [black, isort].
 Use this to customize formatting or disable formatters entirely.
 
+!!! tip "See Also"
+    For built-in formatting configuration, see [Formatting](../formatting.md).
+
 !!! tip "Usage"
 
     ```bash
diff --git a/docs/cli-reference/typing-customization.md b/docs/cli-reference/typing-customization.md
@@ -1826,6 +1826,9 @@ syntax. This feature is experimental.
 
 **Related:** [`--target-python-version`](model-customization.md#target-python-version)
 
+!!! tip "See Also"
+    For detailed explanation and examples, see [Root Models and Type Aliases](../root-model-and-type-alias.md).
+
 !!! tip "Usage"
 
     ```bash
diff --git a/docs/custom-formatters.md b/docs/custom-formatters.md
@@ -21,3 +21,9 @@ and run the following command
 ```sh
 $ datamodel-codegen --input {your_input_file} --output {your_output_file} --custom-formatters "{path_to_your_module}.your_module"
 ```
+
+## See Also
+
+- [CLI Reference: `--custom-formatters`](cli-reference/template-customization.md#custom-formatters) - Detailed CLI option documentation
+- [CLI Reference: `--custom-formatters-kwargs`](cli-reference/template-customization.md#custom-formatters-kwargs) - Pass arguments to custom formatters
+- [Formatting](formatting.md) - Built-in code formatting with black and isort
diff --git a/docs/custom_template.md b/docs/custom_template.md
@@ -58,3 +58,8 @@ class Model(BaseModel):
 ```
 
 In this example, we kept it simple, but you can create more complex custom templates by copying [the default templates](https://github.com/koxudaxi/datamodel-code-generator/tree/main/src/datamodel_code_generator/model/template) Use [the default templates](https://github.com/koxudaxi/datamodel-code-generator/tree/main/src/datamodel_code_generator/model/template) as a reference for understanding the structure and available variables, and customize the code generation process according to your specific requirements.
+
+## See Also
+
+- [CLI Reference: `--custom-template-dir`](cli-reference/template-customization.md#custom-template-dir) - Detailed CLI option documentation
+- [CLI Reference: `--extra-template-data`](cli-reference/template-customization.md#extra-template-data) - Pass custom variables to templates
diff --git a/docs/field-constraints.md b/docs/field-constraints.md
@@ -89,5 +89,9 @@ $ mypy model.py
 Success: no issues found in 1 source file
 ```
 
+## See Also
+
+- [CLI Reference: `--field-constraints`](cli-reference/field-customization.md#field-constraints) - Detailed CLI option documentation with examples
+
 ## Related issues
 [https://github.com/samuelcolvin/pydantic/issues/156](https://github.com/samuelcolvin/pydantic/issues/156)
diff --git a/docs/formatting.md b/docs/formatting.md
@@ -26,3 +26,9 @@ known_first_party = "kelvin"
 ```
 
 See the [Black Project](https://pypi.org/project/black/) for more information.
+
+## See Also
+
+- [CLI Reference: `--formatters`](cli-reference/template-customization.md#formatters) - Specify code formatters
+- [CLI Reference: `--use-double-quotes`](cli-reference/template-customization.md#use-double-quotes) - Use double quotes for strings
+- [Custom Code Formatters](custom-formatters.md) - Create custom formatters
diff --git a/docs/graphql.md b/docs/graphql.md
@@ -193,3 +193,9 @@ class A(BaseModel):
     typename__: Optional[Literal['A']] = Field('A', alias='__typename')
 
 ```
+
+## See Also
+
+- [CLI Reference](cli-reference/index.md) - Complete CLI options reference
+- [CLI Reference: Typing Customization](cli-reference/typing-customization.md) - Type annotation options
+- [CLI Reference: `--extra-template-data`](cli-reference/template-customization.md#extra-template-data) - Custom scalar type mappings
diff --git a/docs/jsonschema.md b/docs/jsonschema.md
@@ -60,4 +60,11 @@ class Person(BaseModel):
     )
     friends: Optional[List] = None
     comment: Optional[Any] = None
-```
+```
+
+## See Also
+
+- [CLI Reference](cli-reference/index.md) - Complete CLI options reference
+- [CLI Reference: Typing Customization](cli-reference/typing-customization.md) - Type annotation options
+- [CLI Reference: Field Customization](cli-reference/field-customization.md) - Field naming and constraint options
+- [Supported Data Types](supported-data-types.md) - JSON Schema data type support
diff --git a/docs/openapi.md b/docs/openapi.md
@@ -345,3 +345,8 @@ readOnly/writeOnly resolution works with local and file reference types:
 |---------------|---------|---------|
 | Local | `#/components/schemas/User` | ✅ |
 | File | `./common.yaml#/User` | ✅ |
+
+## See Also
+
+- [CLI Reference: OpenAPI-only Options](cli-reference/openapi-only-options.md) - All OpenAPI-specific CLI options
+- [CLI Reference: Base Options](cli-reference/base-options.md) - Input/output configuration options
diff --git a/docs/pyproject_toml.md b/docs/pyproject_toml.md
@@ -113,3 +113,9 @@ With a specific profile:
 ```bash
 datamodel-codegen --profile api --generate-cli-command
 ```
+
+## See Also
+
+- [CLI Reference: `--ignore-pyproject`](cli-reference/general-options.md#ignore-pyproject) - Ignore pyproject.toml configuration
+- [CLI Reference: `--generate-pyproject-config`](cli-reference/general-options.md#generate-pyproject-config) - Generate pyproject.toml from CLI arguments
+- [CLI Reference: `--generate-cli-command`](cli-reference/general-options.md#generate-cli-command) - Generate CLI command from pyproject.toml
diff --git a/docs/root-model-and-type-alias.md b/docs/root-model-and-type-alias.md
@@ -262,3 +262,8 @@ class User(BaseModel):
     id: Optional[UserId] = None
     status: Optional[Status] = None
 ```
+
+## See Also
+
+- [CLI Reference: `--use-type-alias`](cli-reference/typing-customization.md#use-type-alias) - Detailed CLI option documentation
+- [CLI Reference: `--target-python-version`](cli-reference/model-customization.md#target-python-version) - Control Python version-specific syntax
diff --git a/docs/what_is_the_difference_between_v1_and_v2.md b/docs/what_is_the_difference_between_v1_and_v2.md
@@ -22,7 +22,12 @@ https://docs.pydantic.dev/2.0/migration/#changes-to-pydanticfield
 - regex (use pattern instead)
 
 ### Model Config
-- `pydantic.Config` -> `pydantic.ConfigDict` 
+- `pydantic.Config` -> `pydantic.ConfigDict`
 - allow_mutation —> frozen (inverse value for getting same behavior).
 - allow_population_by_field_name → populate_by_name
 
+## See Also
+
+- [CLI Reference: `--output-model-type`](cli-reference/model-customization.md#output-model-type) - Select Pydantic v1 or v2 output
+- [CLI Reference: Model Customization](cli-reference/model-customization.md) - All model generation options
+
