How do I validate component documentation before committing?
Run this before committing any change that touches a modeling/ folder or
component_overview.org. See Component documentation guide for the full
structure contract.
Question
How do I validate component documentation before committing?
Answer
From the project root:
./projects/ores.codegen/validate_docs.sh
One check runs: Component structure — every projects/ores.*/ has a
modeling/component_overview.org with the required frontmatter
(:ID:, #+type: component, #+description:), required sections, and
at least one .puml diagram. Exceptions are listed in
projects/ores.codegen/docs_exceptions.txt.
Fix any reported errors, then re-run until the script exits 0.
Script
projects/ores.codegen/validate_docs.sh — runs the component-structure checker.
Tested by
CI gate on every PR. The check runs as part of the documentation validation workflow and the PR goes red if it exits non-zero.
See also
- Component documentation guide — what a correct
component_overview.orglooks like. - How do I fix a failing CI check? — if the check fails in CI.