• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/add-cross-links-between-cli-reference-and-usage-pages

Reviewing files that changed from the base of the PR and between 0857ae7 and 372a981.

• docs/aliases.md (1 hunks)
• docs/cli-reference/field-customization.md (2 hunks)
• docs/cli-reference/general-options.md (2 hunks)
• docs/cli-reference/index.md (1 hunks)
• docs/cli-reference/openapi-only-options.md (1 hunks)
• docs/cli-reference/template-customization.md (3 hunks)
• docs/cli-reference/typing-customization.md (1 hunks)
• docs/custom-formatters.md (1 hunks)
• docs/custom_template.md (1 hunks)
• docs/field-constraints.md (1 hunks)
• docs/formatting.md (1 hunks)
• docs/graphql.md (1 hunks)
• docs/jsonschema.md (1 hunks)
• docs/openapi.md (1 hunks)
• docs/pyproject_toml.md (1 hunks)
• docs/root-model-and-type-alias.md (1 hunks)
• docs/what_is_the_difference_between_v1_and_v2.md (1 hunks)

• GitHub Check: py312-black23 on Ubuntu
• GitHub Check: 3.10 on macOS
• GitHub Check: py312-black22 on Ubuntu
• GitHub Check: 3.11 on Ubuntu
• GitHub Check: py312-isort7 on Ubuntu
• GitHub Check: 3.9 on Windows
• GitHub Check: 3.11 on Windows
• GitHub Check: 3.12 on Windows
• GitHub Check: 3.10 on Ubuntu
• GitHub Check: 3.14 on Ubuntu
• GitHub Check: benchmarks

docs/cli-reference/openapi-only-options.md (1)

3-4: Documentation navigation enhancement approved.

The "Related Documentation" block correctly uses Material for MkDocs admonition syntax and provides a helpful cross-link to the OpenAPI usage guide. Placement and formatting are consistent with best practices.

docs/custom-formatters.md (1)

25-29: "See Also" section enhances navigation.

The cross-reference links to related CLI options and the Formatting guide are well-structured with clear descriptions. Format is consistent and improves documentation discoverability without cluttering the main content.

docs/cli-reference/typing-customization.md (1)

1829-1830: "See Also" tip placement enhances option documentation.

The cross-link to "Root Models and Type Aliases" guide is appropriately placed before the Usage section for --use-type-alias, providing users with contextual related reading. Syntax and formatting are correct.

docs/custom_template.md (1)

62-65: "See Also" section improves template documentation usability.

The cross-links to related CLI options (--custom-template-dir and --extra-template-data) are appropriately placed and clearly described. Format is consistent with other "See Also" sections in the documentation.

docs/cli-reference/index.md (1)

7-17: "Related Documentation" table serves as excellent navigation hub.

The new table effectively cross-references all major documentation topics (schema types, configuration, customization features) with clear descriptions. Table format is clean, scannable, and strategically placed. Relative paths are correct and consistent.

docs/root-model-and-type-alias.md (1)

266-269: "See Also" section appropriately concludes guide with CLI references.

The cross-links to --use-type-alias and --target-python-version are thematically relevant and clearly described. Placement at the end of the guide provides helpful pointers to related CLI options. Format is consistent with other documentation sections.

docs/field-constraints.md (1)

92-94: "See Also" section bridges examples to detailed CLI reference.

The single cross-link to --field-constraints in the CLI reference is contextually perfect, with description text highlighting the availability of additional detailed examples. Placement and format are appropriate.

docs/cli-reference/field-customization.md (2)

37-38: "See Also" tip directs users to detailed Field Aliases guide.

Cross-link to the Field Aliases guide is appropriately placed immediately after the --aliases option description, with clear directive to see the related usage documentation. Syntax and relative path are correct.

---

859-860: "See Also" tip highlights mypy compatibility benefit of field constraints.

Cross-link to the Field Constraints guide is well-placed and the description text explicitly mentions the mypy compatibility benefit, guiding users to valuable related information. Syntax and relative path are correct.

docs/cli-reference/general-options.md (2)

1392-1393: Proper MkDocs admonition syntax for cross-reference.

The "See Also" tip uses standard MkDocs formatting and is well-placed within the --generate-pyproject-config option documentation. Verify that the anchor reference resolves correctly in your documentation build.

---

1601-1602: Consistent cross-reference formatting in --ignore-pyproject section.

This "See Also" tip mirrors the one in the --generate-pyproject-config section, maintaining consistency across related CLI options. Both link to the same pyproject.toml configuration guide, which is appropriate.

docs/aliases.md (1)

111-113: Verify the CLI reference link is correctly anchored.

The "See Also" section is well-placed and clearly formatted. Confirm that docs/cli-reference/field-customization.md contains an #aliases section anchor so the link resolves correctly.

docs/graphql.md (1)

197-201: Well-organized cross-references connecting GraphQL docs to CLI options.

The "See Also" section appropriately links to general CLI reference, typing customization, and the specific --extra-template-data option (which directly relates to custom scalar types discussed in the document). All linked sections exist and anchors are correctly configured.

docs/formatting.md (1)

30-34: Cross-references verified and correct.

All target files exist with properly defined anchors. The "See Also" links correctly reference CLI options in template-customization.md using valid anchor syntax ({#formatters} and {#use-double-quotes}) and link to the existing custom-formatters.md guide.

docs/openapi.md (1)

349-352: Strategic placement of OpenAPI-specific CLI references.

The "See Also" section logically connects the OpenAPI documentation to both OpenAPI-specific options and base configuration options, allowing readers to discover relevant CLI parameters. Both target files exist and are correctly referenced with appropriate descriptions.

docs/jsonschema.md (1)

65-70: Comprehensive "See Also" section connecting JSON Schema documentation to CLI and data type references.

These four links provide good navigation paths from the JSON Schema usage guide to related CLI options and supporting documentation. The inclusion of supported-data-types.md is particularly relevant since data type support is central to JSON Schema generation. All target files exist and cross-references are valid.

docs/what_is_the_difference_between_v1_and_v2.md (1)

29-32: Links to model customization and output type selection are valid.

Both cross-references are correctly formatted with valid targets:

• docs/cli-reference/model-customization.md file exists
• The #output-model-type anchor is properly defined in the referenced file
• Links will successfully navigate to the intended documentation sections

docs/pyproject_toml.md (1)

117-121: Well-organized bidirectional cross-links to CLI options.

The "See Also" section creates a logical hub connecting pyproject.toml documentation to the three most relevant CLI options (--ignore-pyproject, --generate-pyproject-config, --generate-cli-command). All anchor references in general-options.md are present and correctly linked.

docs/cli-reference/template-customization.md (1)

474-475: All linked documentation files exist and relative paths resolve correctly. The three target files are confirmed:

• docs/custom-formatters.md
• docs/custom_template.md
• docs/formatting.md

Note: The file naming uses a mix of kebab-case (custom-formatters.md, formatting.md) and snake_case (custom_template.md). This inconsistency exists in the repository structure pre-PR, so the links accurately reflect actual filenames.