AGENT SKILL

gsd-docs-update

Generate or update project documentation verified against the codebase

License 许可
Apache-2.0
所属仓库
tamarillo-ai/theta
最近更新
2026-07-15
Stars
★ 15
Forks
1

01 前言 Front Matter

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

03 SKILL.md 正文

<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 (Execute mode), present a plain-text numbered list and pick a reasonable default.

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 (Codex uses per-role config, not inline model selection)
  • fork_context: false by default — GSD agents load their own context via <files_to_read> blocks

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>

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

<execution_context> @C:/Users/barnardh/source/repos/MarkdownPreview/.codex/get-shit-done/workflows/docs-update.md </execution_context>

<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 </context>

<process> Execute the docs-update workflow from @C:/Users/barnardh/source/repos/MarkdownPreview/.codex/get-shit-done/workflows/docs-update.md end-to-end. Preserve all workflow gates (preservation_check, flag handling, wave execution, monorepo dispatch, commit, reporting). </process>

04 同仓库更多 Skills