Skip to content

Correct the Agents docs section and add a create-with-context tip - #996

Merged
selfcontained merged 1 commit into
mainfrom
agt_3c372b8dd463/docs-audit-agents-section
Aug 23, 2026
Merged

Correct the Agents docs section and add a create-with-context tip#996
selfcontained merged 1 commit into
mainfrom
agt_3c372b8dd463/docs-audit-agents-section

Conversation

@selfcontained

Copy link
Copy Markdown
Owner

Nightly docs audit. Diff since the last audited SHA (f4ef1ae0) was the previous run's own docs PR (#991), a wire-type change (#992) and tests (#995), so no pivot — this run executed the standing next_focus: a deep dive of the docs-pane Agents section, the largest one and the only one that had never had a dedicated pass.

Audited

apps/web/src/components/app/docs-sections/agents.tsx against create-agent-dialog.tsx / use-create-agent-form.ts / create-agent-worktree-section.tsx, agent-card*.tsx, child-agent-row.tsx, agent-lineage.ts, center-pane-tab-bar.tsx, changes-settings-popover.tsx, session-settings-dialog.tsx, diff-stat-badge.tsx, quick-phrases/, agents/archive.ts, terminal/injection-coordinator.ts, and shared/mcp/whiteboard-tools.ts.

Verified clean as sets in both directions and left alone: the five agent types vs AGENT_TYPES, the model catalog gate (cursor/opencode have no entry, so no picker), the four setup phases, the three top-level sidebar badges, the three center-pane tabs, the four diff-settings controls, the sub agent overflow menu's five items, the fixed/dismissed resolutions, the 10s/60s injection timings and the off-by-default server-wide hold setting, the rename exclusions, and the review-child cascade on archive.

Changed

  • Worktree controls no longer "appear."[codex] Improve working directory input #617 swapped the collapsing grid-rows-[0fr] for grid-rows-[1fr] + disabled, so the Starting branch picker, the new-branch checkbox, and the branch-name input are always on screen, dimmed, until the worktree box is checked. The Worktrees section already described it that way; this one hadn't caught up.
  • Which create-form choices persist, and at what granularity — per directory for full access / Autonomous Review / starting branch / new-branch, per directory and agent type for the model.
  • Pause is in the expanded card's footer, resume is on the collapsed row. The docs read as though both sat in the same place.
  • The Review button launches one or more reviewers (the Launch Review dialog's persona rows are checkboxes).
  • The diff-stats badge dims only when the compute is also over 30s old (STALE_AFTER_MS), not on any activity since the compute.
  • Whiteboard is four MCP tools, not threewhiteboard_howto has been missing from this section since Trim MCP tool responses to what a calling agent needs #945, and whiteboard_update also removes by id. README's table and plugins/dispatch/skills/whiteboard/SKILL.md already listed all four, so the in-app docs were the lone stale surface.
  • Shortcut pins skip the quiet gate like quick phrases and dropped files (inject-pin passes gate: false).
  • The Session details dialog also carries status and the branch/worktree/diff panel — the only way to reach them for a sub agent, whose row has no expandable details.
  • Archiving with worktree removal deletes the Dispatch-created branch, pointing at Worktrees for the cost.

Tip

Added an ambient create-with-context tip. The second create-dialog button seeds a session with instructions, files, and links; it sits next to the primary Create button and is easy to miss, and no existing tip covers it. since: 0.18.1, confirmed with git merge-base --is-ancestor against the #415 feature commit (v0.18.0 does not contain it, v0.18.1 does).

Deferred to next run

next_focus now points at the Media & Sharing section — never deep-dived, and named by five separate stale-docs patterns. Two backlog items land there (the uploads list is missing the create-dialog context picker as a fourth path; dispatch_pins merge-vs-replace is undocumented everywhere user-facing).

Also filed to the backlog, not fixed here: the archive confirm dialog claims it "removes the agent record and all media files," but nothing deletes media on archive — the History detail view explicitly selects it, which is what the docs correctly promise. That's a UI copy fix or a product decision, not docs drift.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WmpcfiDfog8uoWsPd646Wg

Deep-dive of the docs-pane Agents section against the create dialog,
sidebar card, center-pane tabs, archive path, and injection coordinator.
- The create dialog's nested worktree controls stopped collapsing in
#617 (grid-rows-[0fr] -> grid-rows-[1fr] + disabled); they are always
on screen, dimmed, until the worktree checkbox is on. The docs still
said they "appear".
- Say which create-form choices are remembered per working directory
(full access, Autonomous Review, starting branch, new-branch) and
which are per directory and agent type (model).
- Resume is on the collapsed row; pause is only in the expanded card's
footer. The docs described both as if they sat together.
- The Review button launches one or more reviewers, not one.
- The diff-stats badge only dims once the compute is also >30s old
(STALE_AFTER_MS), not on any activity since the compute.
- Whiteboard is four MCP tools, not three: whiteboard_howto has been
missing here since #945, and whiteboard_update also removes by id.
README and the whiteboard SKILL.md already listed all four.
- Shortcut pins are user-initiated and skip the quiet gate, same as
quick phrases and dropped files.
- The Session details dialog also carries status and the details panel,
which is the only way to reach them for a sub agent.
- Archiving with worktree removal deletes the Dispatch-created branch;
point at Worktrees for the cost.
- Add an ambient tip for "Create with context" (v0.18.1, #415), which
has no tip and is easy to miss next to the primary Create button.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WmpcfiDfog8uoWsPd646Wg
@selfcontained
selfcontained merged commit c0c75e8 into mainAug 23, 2026
1 check passed
@selfcontained
selfcontained deleted the agt_3c372b8dd463/docs-audit-agents-section branch August 23, 2026 04:15
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@selfcontained