docs(tools): add coherence tools README
This commit is contained in:
parent
aac95b56d0
commit
c4c06809bd
1 changed files with 31 additions and 0 deletions
31
tools/coherence/README.md
Normal file
31
tools/coherence/README.md
Normal file
|
|
@ -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 <dir>` |
|
||||||
|
|
||||||
|
## 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
|
||||||
Loading…
Add table
Add a link
Reference in a new issue