메뉴
Use when keeping docs in sync with the implementation — sweep command tables/env-vars/paths against the real CLI, keep reference docs current-state-only (migrations go to release notes), enforce identical terminology across CLI help / README / GUI, and track the README install/aqua section against the external aqua-registry.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
| name | docs-audit |
| description | Use when keeping docs in sync with the implementation — sweep command tables/env-vars/paths against the real CLI, keep reference docs current-state-only (migrations go to release notes), enforce identical terminology across CLI help / README / GUI, and track the README install/aqua section against the external aqua-registry. |
Sweep documentation for divergence from the implementation and fix it. Evidence: audit #448 → fix PR #442; self-review sweep PR #245; aqua-version drift #544; export/import docs PR #461; README restructure PR #614; terminology work #409 → PR #412; release/aqua coupling PRs #303, #304, #309.
Compare docs against the real implementation and file/fix each divergence (#448 catalogued them; #442 fixed them):
--help output.Reference/README bodies describe the current state only. Do not write "removed", "no longer", "renamed from", or "BREAKING" in a reference body — describe what the thing is now, in the present tense. Migrations and breaking-change narratives go to release notes, not reference docs (the #456 / PR #461 pattern: the export/import reference docs describe export/import as they exist; the stash→export/import migration lives in the release note).
The same concept uses the same word in CLI help, README, and the GUI. Maintain the native→suve term mapping explicitly (#409 / PR #412): Google Cloud "labels" are surfaced as suve tags; the Azure App Config "label" axis is surfaced as a namespace and is distinct from metadata tags. When one surface changes wording, change all of them in the same PR.
The README install/aqua section must track the external aqua-registry package pkgs/mpyw/suve (regenerated with argd gr; version_constraint floor currently v1.6.1). This drifts independently of the code, so check it every sweep — #544 was exactly this drift (the aqua section advertised an outdated minimum version). Release-archive and install-method changes couple here too (PRs #303, #304, #309).
Use when restructuring the README or the GitHub Pages site generated from it — the left-nav/left-pane, section reorg, or per-provider command docs. Covers the build-docs-site.py split + literate-nav SUMMARY pipeline, its HTML-comment directives and site-only transforms (nav-group, site:skip, hero <h1>, asset ../ prefix, DOC_NAV grouping), the python-markdown gotchas GitHub hides, and the `mise docs-build` strict gate.
Use when authoring or backfilling the "## Highlights" section of a GitHub release — the human-written summary that prepends the auto-generated notes. Covers when a release earns highlights, the fixed format (bold lead + breaking-change note, `###` subsections, PR-referenced bullets), and the prepend-in-place mechanics.
Use when re-recording the CLI, TUI, or GUI demo GIFs after a UI change or a user-visible output change. Covers the record scripts, robust Playwright selectors, output-drift triggers, frame verification, and Git LFS.
Load when writing or reviewing Go that builds or transforms slices/maps. Prefer samber/lo, samber/lo/it, and stdlib slices/maps callback & iterator utilities over hand-rolled make + range + append; keep an explicit loop only where side effects or control flow are genuinely complex.
Load when you need the per-provider capability, versioning, and alias matrix for suve's CLI without reading the full docs/{aws,azure,gcloud}.md option tables. A one-page orientation; link out for per-command detail.
Load when adding or modifying a provider adapter, or when touching internal/provider/** or internal/domain/**. Captures the invariants that keep the provider-neutral seam honest: the neutral domain model, opaque version refs, the typed write/delete option pattern, interface segregation, and SDK confinement.