diff --git a/tools/coherence/README.md b/tools/coherence/README.md index 54a6424..ca399f7 100644 --- a/tools/coherence/README.md +++ b/tools/coherence/README.md @@ -10,22 +10,26 @@ Tools for maintaining site coherence. | check-metadata.py | Validates required fields | `python3 check-metadata.py ` | | fix-frontmatter.py | Adds missing frontmatter | `python3 fix-frontmatter.py ` | | check-links.py | Finds broken internal links | `python3 check-links.py ` | +| run-coherence.py | Runs all checks at once | `python3 run-coherence.py` | -## Usage +## Quick Start ```bash -# Check all fieldnotes -python3 check-frontmatter.py ../public/fieldnotes/ -python3 check-metadata.py ../public/fieldnotes/ -python3 check-links.py ../public/fieldnotes/ +# Run all checks +python3 run-coherence.py -# Fix missing frontmatter -python3 fix-frontmatter.py --dry-run ../public/fieldnotes/ -python3 fix-frontmatter.py ../public/fieldnotes/ +# Or run individual checks +python3 check-frontmatter.py public/fieldnotes/ +python3 check-metadata.py public/fieldnotes/ +python3 check-links.py public/fieldnotes/ + +# Fix issues +python3 fix-frontmatter.py --dry-run public/fieldnotes/ +python3 fix-frontmatter.py public/fieldnotes/ ``` ## Exit Codes -- 0: Success / No issues +- 0: Success / All checks pass - 1: Issues found - 2: Invalid arguments