Skip to content

Z402: ORPHAN_PAGE

Severity: warning Penalty: 4.0 points Category: navigation Auto-fixable: No

Rationale

This rule is triggered when a Markdown source file resides in the docs directory but is not included in the site navigation tree manifest (mkdocs.yml). Orphan pages cannot be reached by users browsing site navigation.

How to Fix

Inspect the flagged location in the Markdown file and update the content or configuration:

Bad (Triggers Z402)

docs/how-to/secret-guide.md -> File exists on disk but missing from mkdocs.yml

Good (Resolves Z402)

# mkdocs.yml - Register file under navigation tree
nav:
  - Secret Guide: how-to/secret-guide.md

Configuration

# Registered under nav: in mkdocs.yml

Reference

See the Finding Codes Index for finding code details.