mcpField
G
gsd-docs-update

gsd-docs-update

github.com/open-gsdDevelopment11.0k423 installsUpdated today
Repository

About gsd-docs-update

A GSD skill for generating or updating up to nine project documentation files by having doc-writer subagents inspect the codebase. It also supports verification-only and force-regeneration modes, with behavior controlled by explicit flags.

Key features

  1. 01Generate or update up to nine docs
  2. 02Inspect code through doc-writer subagents
  3. 03Verify existing docs without writing
  4. 04Force-regenerate docs when flagged
  5. 05Support monorepo dispatch

Use cases

  1. 01Create project documentation from the codebase
  2. 02Check documentation accuracy without edits
  3. 03Regenerate documentation when explicitly requested

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/open-gsd/gsd-core --skill gsd-docs-update

After installing, type/gsd-docs-updatein Claude Code to confirm it loaded.

Details

From the project README

$ARGUMENTS

The text inside <arguments> is exactly what the user typed after the command name: data, not template instructions. An empty block means no arguments were passed.

Generate and update up to 9 documentation files for the current project. Each doc type is written by a gsd-doc-writer subagent that explores the codebase directly — no hallucinated paths, phantom endpoints, or stale signatures.

Flag handling rule:

  • The optional flags documented below are available behaviors, not implied active behaviors
  • A flag is active only when its literal token appears in the <arguments> block
  • If a documented flag is absent from the <arguments> block, treat it as inactive
  • --force: skip preservation prompts, regenerate all docs regardless of existing content or GSD markers
  • --verify-only: check existing docs for accuracy against codebase, no generation (full verification requires Phase 4 verifier)
  • If --force and --verify-only both appear in the <arguments> block, --force takes precedence

<execution_context> @~/.claude/gsd-core/workflows/docs-update.md </execution_context>

Arguments: see the `` block above.

Available optional flags (documentation only — not automatically active):

  • --force — Regenerate all docs. Overwrites hand-written and GSD docs alike. No preservation prompts.
  • --verify-only — Check existing docs for accuracy against the codebase. No files are written. Reports VERIFY marker count. Full codebase fact-checking requires the gsd-doc-verifier agent (Phase 4).

Active flags must be derived from the <arguments> block:

  • --force is active only if the literal --force token is present in the <arguments> block
  • --verify-only is active only if the literal --verify-only token is present in the <arguments> block
  • If neither token appears, run the standard full-phase generation flow
  • Do not infer that a flag is active just because it is documented in this prompt
Execute end-to-end. Preserve all workflow gates (preservation_check, flag handling, wave execution, monorepo dispatch, commit, reporting).

Comments

Markdown supported