| name | exeris-docs-adr-check |
| description | Documentation and ADR consistency review for Exeris Kernel. Use when PRs may cause doc drift, architectural intent changes, or mismatch between repository reality and documented target-state. |
Exeris Docs ADR Check
Purpose
Keep code, docs, and architectural decisions synchronized without over-documenting.
When to Use
- PR changes module placement, boundaries, lifecycle model, provider model, or subsystem contracts.
- PR introduces behavior that differs from documented state.
- PR may require ADR update/new ADR.
Canon to Check
docs/modules/*.md
docs/subsystems/*.md
docs/adr/*.md
docs/architecture.md / docs/whitepaper.md when present and relevant
Procedure
- Detect behavior/boundary deltas in code.
- Map deltas to affected docs and ADRs.
- Classify outcome:
NO_DOC_CHANGE,
DOC_UPDATE_REQUIRED,
ADR_UPDATE_REQUIRED.
- Propose minimal patch list (file + section + rationale).
Mandatory Checks
- Docs do not claim implementation that does not exist in current repository state.
- Planned/target architecture is clearly marked as planned/target/placeholder.
- ADR intent is preserved; deviations are explicit and justified.
Output Contract
For each finding: drift → impact → minimal doc/ADR action.
Non-Negotiable Rules
- Do not let docs outrun code.
- Do not silently diverge from accepted ADR intent.
- Do not rewrite unrelated docs for style-only reasons.