docs(tools): add run-coherence.py - unified runner
This commit is contained in:
parent
dac78460df
commit
cf483266fc
1 changed files with 13 additions and 9 deletions
|
|
@ -10,22 +10,26 @@ Tools for maintaining site coherence.
|
|||
| check-metadata.py | Validates required fields | `python3 check-metadata.py <dir>` |
|
||||
| fix-frontmatter.py | Adds missing frontmatter | `python3 fix-frontmatter.py <dir>` |
|
||||
| check-links.py | Finds broken internal links | `python3 check-links.py <dir>` |
|
||||
| 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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue