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

docs(tools): add fix-frontmatter.py to README

Browse source
This commit is contained in:
Mark Randall Havens △ The Empathic Technologist 2026-02-13 22:21:55 -06:00
parent 7563597d61
commit fc5ae34f9c
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
tools/coherence/README.md
View file

@ -8,6 +8,7 @@ Tools for maintaining site coherence.
|------|---------|-------| |------|---------|-------|
| 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>` | | check-metadata.py | Validates required fields | `python3 check-metadata.py <dir>` |
| fix-frontmatter.py | Adds missing frontmatter | `python3 fix-frontmatter.py <dir>` |
## Usage ## Usage
@ -16,12 +17,12 @@ Tools for maintaining site coherence.
python3 check-frontmatter.py ../public/fieldnotes/ python3 check-frontmatter.py ../public/fieldnotes/
python3 check-metadata.py ../public/fieldnotes/ python3 check-metadata.py ../public/fieldnotes/
# Check single file # Fix missing frontmatter (dry run first!)
python3 check-metadata.py file.md python3 fix-frontmatter.py --dry-run ../public/fieldnotes/
python3 fix-frontmatter.py ../public/fieldnotes/
``` ```
## Exit Codes ## Exit Codes
- 0: All files pass - 0: Success
- 1: Some files have issues
- 2: Invalid arguments - 2: Invalid arguments