Check if high-level project documentation is consistent with recent code changes
Analyzes project documentation against recent code changes and flags inconsistencies.
/plugin marketplace add fractary/claude-plugins/plugin install fractary-docs@fractary[--fix] [--targets <files>] [--base <ref>]claude-haiku-4-5Check if high-level project documentation (CLAUDE.md, README.md, etc.) is consistent with recent code changes.
# Check all default targets
/docs:check-consistency
# Check specific targets
/docs:check-consistency --targets "CLAUDE.md,README.md"
# Check and auto-fix (with confirmation)
/docs:check-consistency --fix
# Check against specific base branch
/docs:check-consistency --base develop
| Argument | Description | Default |
|---|---|---|
--fix | Generate and apply update suggestions | false |
--targets | Comma-separated list of target docs | CLAUDE.md,README.md,docs/README.md,CONTRIBUTING.md |
--base | Base git reference for comparison | main |
--head | Head git reference for comparison | HEAD |
--mode | Operation mode: confirm, auto, dry-run | confirm |
The following documents are checked by default:
CLAUDE.md - Project instructions for Claude CodeREADME.md - Main project readmedocs/README.md - Documentation indexCONTRIBUTING.md - Contribution guidelinesThe command analyzes the git diff between base and head refs and identifies:
It then determines which documentation sections may need updates based on the type of changes detected.
šÆ STARTING: Documentation Consistency Check
Targets: CLAUDE.md, README.md, docs/README.md, CONTRIBUTING.md
Base: main ā Head: HEAD
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
š Changes Detected:
Features: 2 new skills added
Architecture: 1 config file modified
Configuration: 0
š Document Status:
ā ļø CLAUDE.md - STALE
Sections affected: Directory Structure, Common Development Tasks
ā
README.md - Current
ā
docs/README.md - Current
āļø CONTRIBUTING.md - Not found
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā
COMPLETED: Documentation Consistency Check
Status: stale
Documents needing updates: 1
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
Next: Run with --fix to generate update suggestions
This command is automatically invoked during the FABER Release phase to ensure documentation is updated before PR creation.
Use the @skill-fractary-docs:doc-consistency-checker skill with the following request:
{
"operation": "check",
"parameters": {
"targets": ["CLAUDE.md", "README.md", "docs/README.md", "CONTRIBUTING.md"],
"base_ref": "main",
"head_ref": "HEAD",
"mode": "confirm"
}
}