open-gsd/gsd-core

gsd-docs-update

Generate or update project documentation verified against the codebase

Ver código fuente

Cómo usar

  1. Copia el comando y revisa el paquete antes de instalarlo en tu entorno de agente.
  2. Consulta las herramientas, credenciales y entornos necesarios en el documento original.
  3. Describe las entradas y el resultado deseado; contrasta la salida con las fuentes.
npx skills add https://github.com/open-gsd/gsd-core --skill gsd-docs-update

Antes de empezar

  • La instalación no incluye suscripción al modelo, cuota API ni permisos sobre tus archivos.
  • Las estrellas e instalaciones reflejan actividad, no una prueba independiente de calidad o seguridad.
Documento original del Skill

Contenido del repositorio de origen con títulos, ejemplos, código, tablas, enlaces e imágenes preservados.

<arguments>$ARGUMENTS</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.

<objective> 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

</objective>

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

<context> Arguments: see the <arguments> 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

</context>

<process> Execute end-to-end. Preserve all workflow gates (preservation_check, flag handling, wave execution, monorepo dispatch, commit, reporting). </process>

Relacionados por tarea

del mismo repositorio

Más Skills

Todos los Skills