| name | update-docs |
| description | Use when files under docs/ may be stale. Discovers commits since the last docs update, maps changed source files to affected conceptual documentation, and brings docs/*.md back into sync. |
Updating the Docs
Governing spec sections: §11.1 (docs/ directory — the required conceptual docs tree), §21.5 (this skill is mandated because docs/ is a drift-prone artifact in every project).
The docs/ directory contains conceptual documentation for spotifai. Unlike the README (overview) or man pages (command reference), docs/ explains why and how in depth. It goes stale whenever a user-visible behavior, configuration key, or supported surface changes without a matching edit.
Tracking mechanism
.agent/skills/update-docs/.last-updated contains the git commit hash from the last successful run. Empty means "never run" — fall back to the repository's initial commit.
Discovery process
-
Read the baseline:
BASELINE=$(cat .agent/skills/update-docs/.last-updated)
-
List commits since the baseline:
git log --oneline "$BASELINE"..HEAD
-
List changed files:
git diff --name-only "$BASELINE"..HEAD
-
Categorize using the mapping table below.
Mapping table
| Changed files / scope | Doc(s) to update |
|---|
| Public API surface | docs/getting-started.md, architecture-level docs |
| Configuration keys / env vars | docs/configuration.md |
| Error messages and exit codes | docs/troubleshooting.md |
| Deployment / install mechanics | docs/getting-started.md |
Extend this table every time you find a new source file that feeds the docs.
Update checklist
Verification
- Re-read every edited doc section against the current source of truth.
- Click every internal cross-link and confirm the target still exists.
- Confirm
.last-updated was rewritten.
Skill self-improvement
- Grow the mapping table with any new source → doc relationship you discovered.
- Record recurring patterns you had to invent.
- Commit the skill edit alongside the docs change so the knowledge compounds.