// Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure.
| name | documentation-structure |
| description | Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure. |
Document structure only: heading hierarchy, section ordering, presence of required sections (introduction, prerequisites, steps, reference), file naming, metadata blocks, navigation, and cross-references.
documentation-diataxis skill, when run as part of the orchestrated review).File Naming:
Verify files use lowercase with dashes
and the correct extension for their syntax
(for example, connect-vscode.rst for reST, connect-vscode.md for MyST).
Metadata:
Ensure every page has required metadata near the top
when the repository's docs conventions require it:
.. meta:: after the anchor label for reST,
or the MyST equivalent (front matter or meta directive) for Markdown sources.
Directory Placement:
Confirm the file is located in the directory matching its intended
Diataxis category
(for example, tutorials in tutorial/, how-to guides in how-to/).
Navigation:
Ensure new pages are added to the toctree.
Cross-References:
:ref: for reST, {ref}/{numref} for MyST) over page-level links.:doc:/{doc} (or equivalents)
except for index-like pages that are unlikely to be moved or renamed.Verification:
Confirm the structural audit completed:
State the completion status:
✓ Structure audit complete: [N] violations found✓ Structure audit complete: No violations foundA list of structural or metadata violations covering file naming, metadata, directory placement, navigation, and cross-reference issues.
Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting. Use when checking documentation style or validating MyST/reST syntax. Cites specific style guide violations.
Validates documentation builds successfully. Use when checking Sphinx/RTD build integrity or diagnosing build failures. Reports errors, warnings, and build configuration issues.
Analyzes documentation against Diataxis framework (Tutorial, How-to, Reference, Explanation). Use when reviewing documentation structure or classifying content type. Identifies misalignments between declared category and actual content.
Performs comprehensive documentation review including build validation, Diataxis analysis, structure audit, accuracy verification, and style compliance. Use when reviewing documentation changes or auditing documentation quality.
Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code. Use when validating documentation correctness or checking code-docs consistency. Flags unsupported or outdated claims.
