Skip to main content

Document metadata

Status
Maintained
Approval
Approved
Version
1.0
Classification
PUBLIC
Owner
Lightning IT Documentation Maintainers
Approver
Lightning IT Product Owners
Audience
documentation maintainers, tool developers
Last reviewed
Next review
(Annual)

IHR rule catalog

rules/ihr-rules.yml is the authoritative catalog for LIT-DOC-IHR 1.0.0. Rule IDs remain stable and language-neutral. Findings use schemas/ihr-finding.schema.json and include rule ID, severity, message, and location. scripts/validate-ihr.mjs implements the catalogued IHR rules, including bounded secret-pattern checks. The YAML catalog and validator are separate, version-controlled sources and changes to either require tests proving that they remain synchronized. The repository-wide content validator provides the broader secret and publication-boundary scan, while Vale supplies additional prose checks. The initial families are IHR-SCHEMA, IHR-LANG, IHR-PLAN, IHR-PLATFORM, IHR-NET, IHR-READY, IHR-ACTUAL, IHR-DEVIATION, IHR-HANDOVER, IHR-ACCEPT, IHR-SECRET, and IHR-IMMUTABLE.