mrhavens/thefoldwithin-earth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

docs(tools): update README with check-metadata

Browse source
This commit is contained in:
Mark Randall Havens △ The Empathic Technologist 2026-02-13 22:20:16 -06:00
parent 74293b5949
commit 7e91572505
1 changed files with 5 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
tools/coherence/README.md
View file

@ -7,25 +7,21 @@ Tools for maintaining site coherence.
| Tool | Purpose | Usage | | Tool | Purpose | Usage |
|------|---------|-------| |------|---------|-------|
| check-frontmatter.py | Validates YAML frontmatter exists | `python3 check-frontmatter.py <dir>` | | check-frontmatter.py | Validates YAML frontmatter exists | `python3 check-frontmatter.py <dir>` |
| check-metadata.py | Validates required fields | `python3 check-metadata.py <dir>` |
## Usage ## Usage
```bash ```bash
# Check all fieldnotes # Check all fieldnotes
python3 check-frontmatter.py ../public/fieldnotes/ python3 check-frontmatter.py ../public/fieldnotes/
python3 check-metadata.py ../public/fieldnotes/
# Check single file # Check single file
python3 check-frontmatter.py file.md python3 check-metadata.py file.md
``` ```
## Exit Codes ## Exit Codes
- 0: All files have frontmatter - 0: All files pass
- 1: Some files missing frontmatter - 1: Some files have issues
- 2: Invalid arguments - 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