From 7778a89a35c30e9a24ecfa827118587f1268033a Mon Sep 17 00:00:00 2001 From: Brad Harris Date: Fri, 14 Aug 2026 22:06:37 -0600 Subject: [PATCH] Document the Dispatch plugin in the in-app docs (docs audit) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- README.md | 4 +- apps/web/src/components/app/docs-pane.tsx | 10 ++ .../src/components/app/docs-sections/index.ts | 1 + .../components/app/docs-sections/plugin.tsx | 149 ++++++++++++++++++ apps/web/src/lib/tips/tips.ts | 8 + plugins/dispatch/README.md | 5 +- 6 files changed, 173 insertions(+), 4 deletions(-) create mode 100644 apps/web/src/components/app/docs-sections/plugin.tsx diff --git a/README.md b/README.md index 802e3695..7dfcef61 100644 --- a/README.md +++ b/README.md @@ -231,7 +231,7 @@ These tools only work inside running agent sessions (they require agent-scoped M ## Dispatch plugin (Claude Code + Codex) -This repo doubles as a plugin marketplace. The **Dispatch plugin** ships skills that teach agents how to use the capabilities above — the Brain, subagents, `.dispatch/tools.json`, artifact sharing, the review workflow, the whiteboard, jobs, and templates — so agents discover them instead of having to be told. +This repo doubles as a plugin marketplace. The **Dispatch plugin** ships eleven skills that teach agents how to use the capabilities above — the Brain, subagents, `.dispatch/tools.json`, artifact sharing, the review workflow, UI validation, personas, the whiteboard, jobs, templates, and personalities — so agents discover them instead of having to be told. **Before you install:** plugins on Claude Code and Codex are **unsigned and unsandboxed, and run with your full local user privileges** — this one and every other self-hosted plugin. This plugin ships no executable components (no hooks, no `bin/`, no bundled MCP servers), only markdown skills; [plugins/dispatch/README.md](plugins/dispatch/README.md#trust) shows how to verify that for yourself before running the commands below. @@ -257,7 +257,7 @@ See [plugins/dispatch/README.md](plugins/dispatch/README.md) for what each skill ## Docs -User-facing documentation (agents, keyboard shortcuts, personalities, repo tools, jobs, worktrees, reviewers, status events, media, notifications, updates) lives in the app itself — open the **Docs** pane from the sidebar. The files below are developer-facing references that aren't duplicated in the UI: +User-facing documentation (agents, keyboard shortcuts, personalities, repo tools, templates and jobs, worktrees, reviewers, status events, media, browser feedback, the plugin, notifications, service resources, updates) lives in the app itself — open the **Docs** pane from the sidebar. The files below are developer-facing references that aren't duplicated in the UI: - [API Specification](docs/03-api-spec.md) — complete API endpoint reference - [Agent Lifecycle Model](docs/04-agent-lifecycle.md) — states, transitions, tmux contract diff --git a/apps/web/src/components/app/docs-pane.tsx b/apps/web/src/components/app/docs-pane.tsx index 46669912..23284a4d 100644 --- a/apps/web/src/components/app/docs-pane.tsx +++ b/apps/web/src/components/app/docs-pane.tsx @@ -11,6 +11,7 @@ import { Monitor, MousePointerClick, PlugZap, + Puzzle, Signal, Sparkles, Users, @@ -27,6 +28,7 @@ import { NotificationsContent, PersonalitiesContent, PersonasContent, + PluginContent, ResourcesContent, ShortcutsContent, ToolsContent, @@ -45,6 +47,7 @@ export type DocsSection = | "events" | "media" | "browser-feedback" + | "plugin" | "notifications" | "resources" | "updates"; @@ -128,6 +131,13 @@ const SECTIONS: SectionDef[] = [ title: "Browser Feedback", content: , }, + { + id: "plugin", + label: "Plugin", + icon: Puzzle, + title: "Dispatch Plugin", + content: , + }, { id: "notifications", label: "Notifications", diff --git a/apps/web/src/components/app/docs-sections/index.ts b/apps/web/src/components/app/docs-sections/index.ts index 0408fe48..852ffdcd 100644 --- a/apps/web/src/components/app/docs-sections/index.ts +++ b/apps/web/src/components/app/docs-sections/index.ts @@ -9,5 +9,6 @@ export { EventsContent } from "./events"; export { MediaContent } from "./media"; export { BrowserFeedbackContent } from "./browser-feedback"; export { NotificationsContent } from "./notifications"; +export { PluginContent } from "./plugin"; export { ResourcesContent } from "./resources"; export { UpdatesContent } from "./updates"; diff --git a/apps/web/src/components/app/docs-sections/plugin.tsx b/apps/web/src/components/app/docs-sections/plugin.tsx new file mode 100644 index 00000000..0cbe1bad --- /dev/null +++ b/apps/web/src/components/app/docs-sections/plugin.tsx @@ -0,0 +1,149 @@ +import { Code, CodeBlock, H3, P, Section } from "./primitives"; + +export function PluginContent() { + return ( + <> +

+ Dispatch publishes an official plugin for Claude Code{" "} + and Codex. It ships skills that teach agents how to use + the capabilities documented here — the Brain, subagents, repo tools, + artifact sharing, the review workflow, the whiteboard, jobs, templates, + reviewers, personalities, and UI validation — so an agent discovers them + at the moment it needs one instead of having to be told. The Dispatch + repo doubles as the marketplace it's served from. +

+ +
+

Before you install

+

+ Plugins on both platforms are{" "} + + unsigned and unsandboxed, and run with your full local user + privileges + {" "} + — this one and every other plugin you install from a self-hosted + marketplace. This plugin ships no executable components: no hooks, no{" "} + bin/, no bundled MCP servers, no LSP servers. Everything + it contributes is markdown that agents read. After install,{" "} + claude plugin details dispatch@dispatch prints a + component inventory that should read Hooks (0),{" "} + MCP servers (0), and LSP servers (0). +

+
+ +
+

Installing

+

+ Installing from a marketplace is two steps on both platforms: register + the catalog, then install the plugin from it. Adding the marketplace + installs nothing on its own. +

+

+ Claude Code — from inside a session: +

+ {`/plugin marketplace add selfcontained/dispatch +/plugin install dispatch@dispatch`} +

+ The same two steps run non-interactively as{" "} + claude plugin marketplace add selfcontained/dispatch and{" "} + claude plugin install dispatch@dispatch. That form + doesn't run inside a session, so the skills load the next time you + start Claude Code — or immediately if you run{" "} + /reload-plugins in a session that's already open. +

+

+ Codex — codex plugin add installs from a + configured marketplace snapshot, so the marketplace step is required + here too. /plugins inside a Codex session opens the same + catalog as a browser. +

+ {`codex plugin marketplace add selfcontained/dispatch +codex plugin add dispatch@dispatch`} +
+ +
+

What's in it

+

+ Eleven narrow skills, each written to fire on a situation rather than + a feature name — an agent that doesn't know a capability exists will + never match its name, but will match a description of the spot it's + currently in. +

+
    +
  • + brain — something needs to outlive the session or reach + another agent +
    • +
  • + subagents — work should be delegated, or another agent + needs coordinating +
    • +
  • + repo-tools — a repo script should become a first-class + tool +
    • +
  • + sharing — an artifact needs to reach the user +
    • +
  • + review-workflow — a PR is going up, or review feedback + needs working +
    • +
  • + ui-validation — a UI change needs proving in a browser +
    • +
  • + personas — this repo needs a reviewer with a domain + lens +
    • +
  • + whiteboard — the user's sketch matters, or a diagram + beats prose +
    • +
  • + jobs — work should run on a schedule and report + structurally +
    • +
  • + templates — a launch configuration is worth saving +
    • +
  • + personalities — the user is commenting on how agents + talk +
    • +
+

+ Status reporting, pin discipline, and session naming are deliberately + not skills — they're always relevant, and skills only load on a task + match, so those stay in the launch guidance Dispatch injects into + every agent. +

+
+ +
+

Keeping it updated

+

+ The plugin carries an explicit version in its manifests, so updates + only ship when that version is bumped — routine commits to the repo + don't register as a plugin update. +

+

+ Claude Code — run{" "} + claude plugin update dispatch@dispatch, or{" "} + /plugin marketplace update dispatch first to refresh the + catalog. Auto-update is off by default for third-party marketplaces + like this one; turn it on per-marketplace under /plugin →{" "} + Marketplaces. +

+

+ Codex — there is no update subcommand. Re-run{" "} + codex plugin add dispatch@dispatch to upgrade; it + replaces the cached copy.{" "} + codex plugin marketplace upgrade only refreshes the + catalog snapshot, not the installed plugin, and{" "} + codex plugin list won't tell you a newer version exists. +

+
+ + ); +} diff --git a/apps/web/src/lib/tips/tips.ts b/apps/web/src/lib/tips/tips.ts index 19d386d8..870c7882 100644 --- a/apps/web/src/lib/tips/tips.ts +++ b/apps/web/src/lib/tips/tips.ts @@ -276,6 +276,14 @@ export const tips: Tip[] = [ since: "0.33.7", surfaces: ["ambient"], }, + { + id: "dispatch-plugin", + title: "Teach Your CLI About Dispatch", + body: "Install the Dispatch plugin in Claude Code or Codex and agents pick up skills for the Brain, subagents, repo tools, sharing, and reviews — so they use them without being told.", + docsSection: "plugin#plugin-install", + since: "0.34.1", + surfaces: ["ambient"], + }, ]; export function getTipById(id: string): Tip | undefined { diff --git a/plugins/dispatch/README.md b/plugins/dispatch/README.md index b38ed993..22363bfa 100644 --- a/plugins/dispatch/README.md +++ b/plugins/dispatch/README.md @@ -2,8 +2,9 @@ Skills that teach agents how to use Dispatch's own capabilities. Install it in Claude Code or Codex and agents get shared memory, subagent orchestration, repo -tools, artifact sharing, the review workflow, the whiteboard, jobs, and templates -as discoverable skills instead of tribal knowledge. +tools, artifact sharing, the review workflow, UI validation, personas, the +whiteboard, jobs, templates, and personalities as discoverable skills instead of +tribal knowledge. ## Install