// 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.
| name | documentation-style |
| description | 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. |
Style conformance only: tone, voice, terminology, punctuation, Oxford comma, active versus passive voice, prohibited phrases, and formatting conventions.
references/doc-style-guide.md.https://raw.githubusercontent.com/canonical/sphinx-docs-starter-pack/refs/heads/main/docs/reference/myst-syntax-reference.mdhttps://raw.githubusercontent.com/canonical/sphinx-docs-starter-pack/refs/heads/main/docs/reference/rst-syntax-reference.rstLoad style guides: Read references/doc-style-guide.md.
Fetch the syntax-specific guide matching the file type
(MyST for .md, reST for .rst).
Syntax compliance: Check headings, lists, code blocks, inline literals, and directives against the applicable syntax guide. Treat every instruction in the guide as mandatory; do not rely on a subset of rules.
Full style guide compliance: Read and apply all rules defined
in references/doc-style-guide.md.
Treat every instruction in the guide as mandatory;
do not rely on a subset of rules.
Style guide citation: For every violation found,
locate and quote the specific passage
in references/doc-style-guide.md or the syntax-specific guide
that supports the finding.
Fallback behaviour: If syntax guides cannot be fetched
(offline or network blocked), continue the review
using references/doc-style-guide.md
and the syntax patterns already present in the documentation set.
If references/doc-style-guide.md is unavailable,
STOP the review and report that the style guide cannot be accessed.
Verification:
Confirm the style review completed:
State the completion status:
✓ Style review complete: [N] violations found✓ Style review complete: No violations foundA list of style violations, each accompanied by:
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.
Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references. Use when checking documentation organization or validating toctree structure.
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.