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

docs(tools): add check-links.py to README

Browse source
This commit is contained in:
Mark Randall Havens △ The Empathic Technologist 2026-02-13 22:25:04 -06:00
parent c8fb4f90c7
commit caa4c473bb
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
tools/coherence/README.md
View file

@ -9,6 +9,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>` | | fix-frontmatter.py | Adds missing frontmatter | `python3 fix-frontmatter.py <dir>` |
| check-links.py | Finds broken internal links | `python3 check-links.py <dir>` |
## Usage ## Usage
@ -16,13 +17,15 @@ Tools for maintaining site coherence.
# Check all fieldnotes # Check all fieldnotes
python3 check-frontmatter.py ../public/fieldnotes/ python3 check-frontmatter.py ../public/fieldnotes/
python3 check-metadata.py ../public/fieldnotes/ python3 check-metadata.py ../public/fieldnotes/
python3 check-links.py ../public/fieldnotes/
# Fix missing frontmatter (dry run first!) # Fix missing frontmatter
python3 fix-frontmatter.py --dry-run ../public/fieldnotes/ python3 fix-frontmatter.py --dry-run ../public/fieldnotes/
python3 fix-frontmatter.py ../public/fieldnotes/ python3 fix-frontmatter.py ../public/fieldnotes/
``` ```
## Exit Codes ## Exit Codes
- 0: Success - 0: Success / No issues
- 1: Issues found
- 2: Invalid arguments - 2: Invalid arguments