CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

gsd-docs-update

Generate or update project documentation verified against the codebase

Quality

61%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./pi/package-skills/gsd-docs-update/SKILL.md
SKILL.md
Quality
Evals
Security

Invoke this Pi skill with /skill:gsd-docs-update.

Pi dispatch (fail closed). Pi has no built-in subagent API; GSD provides the gsd_dispatch tool. Where a workflow step dispatches a named gsd-* role, call gsd_dispatch with role (the installed role name) and task (the full task text). A workflow that still writes the step as an Agent(...) call means the same: its subagent_type is the role and its prompt is the task. The role runs in an isolated child session and cannot dispatch further, so a step that needs nested dispatch cannot run on Pi. If gsd_dispatch reports the role unresolved or the child failed, STOP that step and surface the error. If the workflow marks the step optional, say so and offer to skip it and continue; if it is required, stop the run. Never execute the role's work inline as a substitute.

Pi includes. Pi does not expand @path references in a skill. Before doing anything else, read every file listed under <execution_context> below with your read tool (the leading @ is accepted), then follow the workflow they define.

(the text typed after the skill name)

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> @GSD_PI_ENGINE_ROOT/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).
Repository

open-gsd/gsd-core

Path

pi/package-skills/gsd-docs-update/SKILL.md

Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.