|
| 1 | +--- |
| 2 | +name: docs-sync |
| 3 | +description: Sweep the repo's documentation for consistency with the current code and fix drift. Use after feature work, tool/schema changes, renames, or on a maintenance cadence. |
| 4 | +--- |
| 5 | + |
| 6 | +# Docs-sync — keep every doc telling the same story |
| 7 | + |
| 8 | +The documentation set, in canonical order (check each against the code, in this order): |
| 9 | + |
| 10 | +1. `README.md` — public front door. MCP tool table, page list, commands, deployment. |
| 11 | +2. `SECURITY.md` — Apps Script scopes/delegation AND the Worker/MCP auth model, secrets, input handling. |
| 12 | +3. `CLAUDE.md` — agent instructions: architecture notes, invariants, byte-lock rules, current tool behavior. |
| 13 | +4. `TEST.md` — test infrastructure: suites, stubs, commands, what CI runs, what needs manual/visual checks. |
| 14 | +5. `REVIEW.md` — review standard and the latest review record. |
| 15 | +6. Secondary: `mcp/README.md`, `wrangler.toml` comments, MCP tool descriptions in `mcp/src/index.ts`, `mcp/src/server-card.ts` description, `signature-generator/README.md`, `CHANGELOG.md`/`RELEASES.md` links. |
| 16 | + |
| 17 | +## Procedure |
| 18 | + |
| 19 | +1. `git log --oneline -10` and `git diff` to know what changed recently. |
| 20 | +2. Grep for known drift markers — phrases that have gone stale before: |
| 21 | + - `PNG rasterization is a follow-up`, `SVG only`, `three tools`, `exactly the three` |
| 22 | + - `nyuchitech` (org renamed to `nyuchi`) |
| 23 | + - `8px per char` (stub is now size-aware) |
| 24 | + - counts of tools/tests that may have moved |
| 25 | +3. Compare the MCP tool table in `README.md` against `server.registerTool` calls in `mcp/src/index.ts` (names, deprecations, output modes). |
| 26 | +4. Check `CLAUDE.md` claims against reality (paths that must exist, invariants still true). |
| 27 | +5. Fix what's wrong, run the `verify` skill if any `.ts` changed, commit with a `Docs consistency:` message, push to the current feature branch. |
| 28 | +6. If nothing drifted: report "consistent" and change nothing. |
| 29 | + |
| 30 | +Never describe aspirations as shipped: docs state what the code does today. |
0 commit comments