diff --git a/tools/coherence/README.md b/tools/coherence/README.md new file mode 100644 index 0000000..b28f0f3 --- /dev/null +++ b/tools/coherence/README.md @@ -0,0 +1,31 @@ +# Coherence Tools + +Tools for maintaining site coherence. + +## Tools + +| Tool | Purpose | Usage | +|------|---------|-------| +| check-frontmatter.py | Validates YAML frontmatter exists | `python3 check-frontmatter.py ` | + +## Usage + +```bash +# Check all fieldnotes +python3 check-frontmatter.py ../public/fieldnotes/ + +# Check single file +python3 check-frontmatter.py file.md +``` + +## Exit Codes + +- 0: All files have frontmatter +- 1: Some files missing frontmatter +- 2: Invalid arguments + +## Adding New Tools + +1. Create new tool in this directory +2. Add entry to this README +3. Document usage and exit codes