gsd-docs-update

name	gsd-docs-update
description	Generate or update project documentation verified against the codebase
metadata	{"short-description":"Generate or update project documentation verified against the codebase"}

<codex_skill_adapter>

A. Skill Invocation

• This skill is invoked by mentioning $gsd-docs-update.
• Treat all user text after $gsd-docs-update as {{GSD_ARGS}}.
• If no arguments are present, treat {{GSD_ARGS}} as empty.

B. AskUserQuestion → request_user_input Mapping

GSD workflows use AskUserQuestion (Claude Code syntax). Translate to Codex request_user_input:

Parameter mapping:

• header → header
• question → question
• Options formatted as "Label" — description → {label: "Label", description: "description"}
• Generate id from header: lowercase, replace spaces with underscores

Batched calls:

• AskUserQuestion([q1, q2]) → single request_user_input with multiple entries in questions[]

Multi-select workaround:

• Codex has no multiSelect. Use sequential single-selects, or present a numbered freeform list asking the user to enter comma-separated numbers.

Execute mode fallback:

• When request_user_input is rejected or unavailable, you MUST stop and present the questions as a plain-text numbered list, then wait for the user's reply. Do NOT pick a default and continue (#3018).
• You may only proceed without a user answer when one of these is true: (a) the invocation included an explicit non-interactive flag (--auto or --all), (b) the user has explicitly approved a specific default for this question, or (c) the workflow's documented contract says defaults are safe (e.g. autonomous lifecycle paths).
• Do NOT write workflow artifacts (CONTEXT.md, DISCUSSION-LOG.md, PLAN.md, checkpoint files) until the user has answered the plain-text questions or one of (a)-(c) above applies. Surfacing the questions and waiting is the correct response — silently defaulting and writing artifacts is the #3018 failure mode.

C. Task() → spawn_agent Mapping

GSD workflows use Task(...) (Claude Code syntax). Translate to Codex collaboration tools:

Direct mapping:

• Task(subagent_type="X", prompt="Y") → spawn_agent(agent_type="X", message="Y")
• Task(model="...") → omit. spawn_agent has no inline model parameter; GSD embeds the resolved per-agent model directly into each agent's .toml at install time so model_overrides from .planning/config.json and ~/.gsd/defaults.json are honored automatically by Codex's agent router.
• fork_context: false by default — GSD agents load their own context via <files_to_read> blocks
• Task(isolation="worktree") / Agent(isolation="worktree") → no direct Codex mapping. Codex spawn_agent does not create or bind a git worktree automatically. Workflows that require this isolation must fail closed or use an explicit manual worktree protocol before spawning (#3360).

Spawn restriction:

• Codex restricts spawn_agent to cases where the user has explicitly requested sub-agents. When automatic spawning is not permitted, do the work inline in the current agent rather than attempting to force a spawn.

Parallel fan-out:

• Spawn multiple agents → collect agent IDs → wait(ids) for all to complete

Result parsing:

• Look for structured markers in agent output: CHECKPOINT, PLAN COMPLETE, SUMMARY, etc.
• close_agent(id) after collecting results from each agent </codex_skill_adapter>

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 {{GSD_ARGS}}
• If a documented flag is absent from {{GSD_ARGS}}, 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 {{GSD_ARGS}}, --force takes precedence

<execution_context> @/Users/lmarques/Dev/efx-mux/.codex/get-shit-done/workflows/docs-update.md </execution_context>

Arguments: {{GSD_ARGS}}

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 {{GSD_ARGS}}:

• --force is active only if the literal --force token is present in {{GSD_ARGS}}
• --verify-only is active only if the literal --verify-only token is present in {{GSD_ARGS}}
• 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).