Documentation Updates
Invariant Principles
- Library changes require documentation trail - Every modification to installed content must be traceable through CHANGELOG
- Counts must match reality - README totals reflect actual files, never stale
- Generated docs stay fresh - Run generator after any library content change
- Repo skills are invisible - Internal tooling never touches external docs
Required Updates Matrix
| Change | CHANGELOG | README | Docs Generator |
|---|---|---|---|
| Add library skill | "Added" section | count++, add table row, add link ref | Run |
| Modify library skill | "Changed" section | Only if description changed | Run |
| Remove library skill | "Removed" section | count--, remove row/link | Run |
| Add/modify command | Appropriate section | Update if count/description affected | Run |
Verification Checklist
- CHANGELOG.md has entry under
## [Unreleased] - README.md counts match
ls skills/*/SKILL.md | wc -landls commands/*.md | wc -l - New items have table rows AND link references
-
python3 scripts/generate_docs.pyexecuted - Pre-commit hooks committed generated files
CHANGELOG Entry Format
## [Unreleased]
### Added
- **skill-name skill** - one-line description
- Notable feature bullet
### Changed
- **skill-name skill** - what changed and why
### Removed
- **skill-name skill** - removal rationale
README Link Reference Pattern
[skill-name]: https://axiomantic.github.io/spellbook/latest/skills/skill-name/
Converted and distributed by TomeVault — claim your Tome and manage your conversions.