Skip to content

Document the Dispatch plugin in the in-app docs (docs audit) - #960

Merged
selfcontained merged 1 commit into
mainfrom
agt_fe366a4d9c63/job-doc-ter-0bab1665
Aug 15, 2026
Merged

Document the Dispatch plugin in the in-app docs (docs audit)#960
selfcontained merged 1 commit into
mainfrom
agt_fe366a4d9c63/job-doc-ter-0bab1665

Conversation

@selfcontained

Copy link
Copy Markdown
Owner

Nightly docs audit. Slice: the deep-dive area carried in next_focus — the official Dispatch plugin (#952), which shipped with a README section and no in-app docs coverage at all.

The diff since the last audited SHA (037f4601..HEAD) was three PRs, all of which were either the previous audit's own docs work or dead-code deletion, so nothing was diff-driven this run.

What changed

  • New docs-pane section "Plugin" (docs-sections/plugin.tsx) — trust first (unsigned/unsandboxed, ships no executable components, claude plugin details as the verification), then the two-step marketplace + install flow on both Claude Code and Codex, the eleven skills and the situation each fires on, and update mechanics (auto-update off by default on Claude Code; Codex has no update subcommand so upgrading means re-running codex plugin add).
  • Ambient tip dispatch-pluginplugin#plugin-install, since: 0.34.1. The plugin commit (fe8a46ba) is not an ancestor of Release v0.34.0; the nearest release after it is v0.34.1.
  • README skill enumeration named 8 skills where plugins/dispatch/skills/ has 11 — personas, personalities and ui-validation were missing. Same fix in plugins/dispatch/README.md's intro paragraph (its own table below was already correct).
  • README docs index listed the in-app sections as a set that was missing browser feedback, service resources and the new plugin section, and said "jobs" where the section is templates and jobs.

Validation

pnpm run format:write, pnpm run check, apps/web tips unit tests, and a Playwright render of /settings/help/plugin on an isolated dev stack (nav entry present, section renders, 0 console errors).

Deferred to next run

  • next_focus → audit docs-pane Automations (templates & jobs) against apps/web/src/components/app/automations-* and apps/server/src/jobs/ — it has three open backlog items (defaultArgs has no UI, the vestigial "Show in command palette" toggle, JobNotifyConfig) and hasn't been deep-dived.
  • New backlog item: the plugin manifests' description field (both .claude-plugin/plugin.json and .codex-plugin/plugin.json, plus .claude-plugin/marketplace.json) still names the same 8 skills. Left alone here because those strings are published marketplace metadata and changing them is a version-bump call, not a docs fix.

The official plugin (#952) shipped with a README section and nothing else —
no in-app docs section and no ambient tip, so the only place a user learns
it exists is the GitHub README.

- New docs-pane section "Plugin" covering trust (unsigned/unsandboxed, no
  executable components, how to verify), the two-step marketplace + install
  flow on Claude Code and Codex, the eleven skills and what each fires on,
  and update mechanics (Codex has no update subcommand).
- Ambient tip pointing at plugin#plugin-install, since 0.34.1 (the plugin
  landed after the v0.34.0 release commit).
- README's plugin blurb named 8 skills; the tree has 11 — personas,
  personalities and ui-validation were missing. Same fix in
  plugins/dispatch/README.md's intro paragraph.
- README's "user-facing documentation" list was missing browser feedback,
  service resources and the new plugin section, and said "jobs" where the
  section is templates and jobs.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@selfcontained
selfcontained merged commit de0bf58 into main Aug 15, 2026
1 check passed
@selfcontained
selfcontained deleted the agt_fe366a4d9c63/job-doc-ter-0bab1665 branch August 15, 2026 04:12
Sign up for free to 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