Linking policy

{ #policy-linking-mandatory }

Stable ID: POLICY-LINKING-MANDATORY

Status

This policy is mandatory.

Scope

This policy governs documentation links and references.

Requirements

  1. Section overviews should link to the pages they introduce.
  2. Concept, feature, workflow, and documentation-system overview pages should use navigable links.
  3. Internal documentation links should resolve correctly.
  4. Image references should point to existing files.
  5. Important pages should expose stable anchors where appropriate.
  • Prefer relative links within the documentation tree.
  • Use stable section anchors for durable references.
  • Avoid dead links to repository-external paths from the built documentation site.

Enforcement