update-docs

Update Documentation

Invoke the dso:doc-writer agent to review and update project documentation based on recent changes. Accepts an optional commit range to scope the git diff.

Usage

/dso:update-docs                      # Diff scoped to main...HEAD (default)
/dso:update-docs <commit-range>       # Diff scoped to the specified commit range

Examples:

• /dso:update-docs — updates docs for all commits since main
• /dso:update-docs HEAD~5..HEAD — updates docs for the last 5 commits
• /dso:update-docs abc123..def456 — updates docs for a specific range

---

Step 1: Resolve the Commit Range

Determine the commit range to use:

• If a <commit-range> argument was provided, use it as-is.
• Otherwise, default to main...HEAD.

REPO_ROOT=$(git rev-parse --show-toplevel)
COMMIT_RANGE="${1:-main...HEAD}"

Step 2: Gather Context

Collect the inputs the doc-writer agent requires:

# Git diff scoped to the commit range
git diff "$COMMIT_RANGE"

# Recent git log for the range (context for the agent)
git log --oneline "$COMMIT_RANGE"

# Project context
cat "$REPO_ROOT/CLAUDE.md" 2>/dev/null | head -200

If git diff "$COMMIT_RANGE" returns empty output, inform the user:

"No changes found in commit range <commit-range>. Nothing to document."

And stop — do not dispatch the agent.

Step 3: Dispatch dso:doc-writer

Inline dispatch is required — dso:doc-writer is an agent file identifier, NOT a valid subagent_type value. The Agent tool only accepts built-in types (general-purpose, Explore, Plan, etc.).

Read agents/doc-writer.md inline and dispatch as subagent_type: "general-purpose" with model: "sonnet". Pass the agent file content verbatim as the prompt, appending the context below.

Agent tool:
  subagent_type: "general-purpose"
  model: "sonnet"
  prompt: |
    {verbatim content of ${CLAUDE_PLUGIN_ROOT}/agents/doc-writer.md}

    --- PER-RUN CONTEXT ---
context:
  epic_context: |
    ## Commit Range
    <commit-range>

    ## Recent Commits
    <output of git log --oneline for the range>

    ## Project Context (from CLAUDE.md)
    <first 200 lines of CLAUDE.md, or "Not available">

  git_diff: |
    <full output of git diff for the commit range>