원클릭으로
documentation
Update stale documentation and comments to match current code
메뉴
Update stale documentation and comments to match current code
Tag a new version, push to trigger CI, monitor the build, and verify the GitHub release
Extract and persist conversation learnings before context loss. TRIGGER when: user runs /reflect, or before /clear or compaction.
Guidelines for creating and updating Claude Code skills. TRIGGER when: writing a new SKILL.md, modifying an existing skill, or the user asks about skill conventions.
Analyzes changes and generates Conventional Commit messages
Arrange a project's README and GitHub Pages documentation into a consistent user-first layout: short README that links out, just-the-docs Jekyll site with a user-facing index, one page per user-facing feature (split into child pages when long), and a developer guide with technical sub-pages. TRIGGER when: setting up docs/ for a new project, adding a GitHub Pages site, writing or restructuring a README that will link to GH Pages, adding a new user-facing feature page, or asked to align docs with this project or bga-assistant. DO NOT TRIGGER when: editing unrelated docs outside docs/, working on a project that already has an incompatible docs framework (Docusaurus, MkDocs, VitePress, etc.).
Create or update the data flow architecture document (docs/pages/data-flow.md).
| name | documentation |
| description | Update stale documentation and comments to match current code |
| allowed-tools | Read, Edit, Write, Grep, Glob, Bash(git diff:*), Bash(git status:*), Bash(git rev-parse:*) |
Scan project documentation and comments for references that no longer match the code, and fix them.
git rev-parse --show-toplevel 2>/dev/null || pwdgit status --shortgit diff HEAD --statgit diff HEADR=$(git rev-parse --show-toplevel 2>/dev/null || pwd) && test -f "$R/docs/index.md" && echo yes || echo noAll file paths below (README.md, docs/, docs/pages/, docs/index.md, CLAUDE.md) are relative to Repo root from Context. The current working directory may be a subdirectory (e.g. src-tauri/, frontend/), so always prefix the Repo root value when calling Read/Edit/Write/Grep/Glob. Bare paths are cwd-relative and will silently miss files that live at the actual root.
Read README.md (at the repo root) and fix any references to changed paths, APIs, or behavior
Read all files in docs/pages/ (if the folder exists) and check for both staleness and gaps:
docs/pages/features.md), any enumerated feature list in docs/index.md, and the README's feature list. Add a new entry for a new feature; revise the existing entry for a changed one. A feature that exists in code but is absent from (or stale in) these listings is a documentation gap even when every other page is accurate. Propose the additions/edits and wait for approval```mermaid blocks, ASCII flowcharts/trees, and structural tables) that depict architecture, data flow, state machines, or file layout. When code changes — or another doc you just edited — alters the structure a diagram illustrates (a renamed/removed module, a new component, a changed path or edge), update the diagram itself, not just the surrounding prose. A stale node, missing arrow, or wrong label in a diagram is as misleading as stale text.### where siblings use ##). Also re-verify its relative links resolve from the new location.Align README with the GH Pages index — only if GH Pages index present is yes. Read README.md and docs/index.md together and reconcile them so they describe the same product at the same point in time:
docs/index.md section (same facts, same scope claims). Wording may differ slightly; facts must not.https://<org>.github.io/<repo>/pages/<feature> (or /pages/<product> in the monorepo variant) and the corresponding docs/pages/<feature>.md file must exist.docs/pages/ (user-facing pages + Developer guide); no page may be listed that doesn't exist, and no existing user-facing page may be missing.docs/index.md + docs/pages/<feature>.md as the source of truth and update the README to match.Read CLAUDE.md (project-local .claude/CLAUDE.md if it exists, otherwise repo root) and fix any stale file descriptions
Check comments and docstrings in modified source files (use Uncommitted changes and Full diff to identify them) that reference changed behavior
Update dimensioned drafts — only if the repo keeps drafts (Glob **/dimensioned_drafts/*.py outside ignored dirs; skip this step when nothing matches). Drafts are documentation of model geometry: when a model source file changed in the diff, find the draft scripts that document it (match by model name/directory and by constants mirrored from the model's dimensions class) and check every drawn value — dimensions, profile vertices, removed/added features, not just labels. Update the draft script to the current model, re-run it to regenerate the SVG, and include both files in the change set. A draft documenting a feature the model no longer has is stale documentation just like prose.
Suggest improvements — if documentation would benefit from a new file or reorganization, suggest it to the user and wait for approval before proceeding
Report what was updated. If nothing was stale, say so. Call out README ↔ docs/index.md mismatches explicitly, even when fixed.