Update Docs

Update Docs

Run this after any meaningful change to the codebase. It checks every documentation location, determines who needs to know about the change, and helps you update what's stale.

Step 1 — Understand what changed

Figure out the scope of recent changes. Use whichever applies:

# Changes on the current branch vs master
git log --oneline master..HEAD
git diff --stat master..HEAD

# Or if working on master, recent commits
git log --oneline -10

Summarize the changes in one sentence. Classify the change type:

Step 2 — Determine affected audiences

For each change, ask: who needs to know?

A new component affects all four. A convention change affects contributors and agents. A bug fix might only affect the changelog.

Step 3 — Check each documentation location

Go through every location below. For each one, check whether it's current given the changes. Report a checklist of what needs updating.

End users — docs/src/

End users — root files

Contributors — project/

Design system drift detection: When checking project/design-system.md, verify that components don't use spacing, typography, or radius values outside the documented scales. If a component introduces a new value, either change the component to use an existing scale value or update the scale tables to include the new value with justification.

AI agents — .claude/

External AI — skills/kiso/

Step 4 — Report findings

Present the checklist as a table:

| Status | File | What needs updating |
|--------|------|---------------------|
| OK     | docs/src/components/badge.md | — |
| STALE  | PLAN.md | Mark Breadcrumb as done |
| MISSING| skills/kiso/references/components/toast.md | New component needs reference |

Only show files that are STALE or MISSING — skip the OK ones unless the user wants the full list.

Step 5 — Make the updates

For each STALE or MISSING item, update the file. Follow these rules:

• Don't duplicate content. If the canonical source is project/, update there. Other locations should point to it, not copy from it.
• Component docs (docs/src/components/) follow the format in docs/src/components/card.md.
• Component references (skills/kiso/references/components/) follow the format of existing reference files — concise API summary, not full docs.
• PLAN.md updates are status changes only (mark items done, update "What's Next").

Quick reference — what to update per change type