Skip to content

Z402: ORPHAN_PAGE

  • Severity: Error

    Penalty: 0.0 points | Category: general

  • Remediation & Opt-In

    Auto-Fixable: No | Opt-In: 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:

Configuration

# Registered under nav: in mkdocs.yml

Reference

See the Finding Codes Index for finding code details.