Verify documentation and connect it to the doc set
PublicCheck every code claim against current source and maintain the index and related-document links.
Verify documentation and connect it to the doc set
Check every code claim against current source and maintain the index and related-document links.
Verify method signatures, constants, defaults, field names and types, JSON keys and file paths against current implementation.
Do not document remembered or guessed behavior as fact; identify anything not verified.
For architecture documentation, include a purpose, related documents, contents, overview and appropriate model/layer/API explanations.
Use tables for API summaries, responsibility comparisons, state matrices and file listings.
Use Mermaid flowcharts, class diagrams and sequence diagrams where they clarify real relationships or flows, with English labels and quoted labels containing spaces.
Use a Q&A document for conceptual edge cases and surprising invariants, linked back to its architecture document.
Mark intentionally standalone reference material as codebase-agnostic.
Maintain one H1 per document and an unskipped H2/H3 hierarchy.
Maintain the package's docs/README.md scope statement and index; categorized sets use Doc | Summary tables with useful searchable keywords.
For flat sets, preserve the reading-order guidance, source/doc map, dependency map and out-of-scope guidance.
Add relevant reciprocal related-document links, and use relative links across categories.
Code comments use the full package-relative documentation path.
When moving a document, preserve history with git mv and update references to the old name in source and Markdown.
Use a local glossary or shared docs/GLOSSARY.md as appropriate.
When translating, preserve code identifiers, paths and Mermaid node IDs; translate prose and visible labels.
The detector offers this review reminder on a written document title; it does not claim to verify prose semantics or require every template section for every short document.
Detection scope
This is a contextual review reminder, not proof of a violation. Explicit user instructions and applicable repository conventions take precedence.