Back to all reviewers

Use relative documentation links

opentofu/opentofu
Based on 2 comments
Other

When documenting error handling mechanisms, always use relative path references (`../path/to/file.mdx`) instead of absolute paths (`/docs/path/to/file`) when creating documentation links. This ensures documentation about error handling, assertions, validations, and error recovery patterns remains navigable even when documentation structures change.

Error Handling Other

Reviewer Prompt

When documenting error handling mechanisms, always use relative path references (../path/to/file.mdx) instead of absolute paths (/docs/path/to/file) when creating documentation links. This ensures documentation about error handling, assertions, validations, and error recovery patterns remains navigable even when documentation structures change.

For example, change:

[custom conditions](/docs/language/expressions/custom-conditions)

To use relative paths:

[custom conditions](../expressions/custom-conditions.mdx)

Properly linked documentation is essential for developers to find and implement appropriate error handling strategies. When documentation links break, developers struggle to locate crucial information about error handling techniques, potentially leading to improper implementation of validation checks, error messaging, and recovery mechanisms.

2
Comments Analyzed
Other
Primary Language
Error Handling
Category

Source Discussions