|
| 1 | +# Roadmap: ACP Java SDK 0.9.0 Documentation |
| 2 | + |
| 3 | +> **Created**: 2026-02-10 |
| 4 | +> **Design version**: 0.9.0 |
| 5 | +
|
| 6 | +## Overview |
| 7 | + |
| 8 | +Documentation ships in three stages, ordered by launch criticality. Stage 1 creates the Mintlify documentation site (blocks the 0.9.0 blog post). Stage 2 updates tutorial READMEs and SDK metadata for the release. Stage 3 completes remaining pages post-launch. All documentation follows the code-first workflow: verify tutorial code compiles, then write docs based on working code. |
| 9 | + |
| 10 | +## Stage 1: Mintlify Site (Launch-Critical) |
| 11 | + |
| 12 | +### Step 1.1: Navigation and Scaffolding |
| 13 | + |
| 14 | +**Entry criteria**: |
| 15 | +- [ ] Read: Claude Agent SDK Mintlify structure (`~/community/mintlify-docs/claude-agent-sdk/`) |
| 16 | +- [ ] Read: `~/community/mintlify-docs/mint.json` |
| 17 | + |
| 18 | +**Work items**: |
| 19 | +- [ ] UPDATE `~/community/mintlify-docs/mint.json` with ACP Java SDK section under Incubating Projects |
| 20 | +- [ ] CREATE directory: `~/community/mintlify-docs/acp-java-sdk/` |
| 21 | +- [ ] CREATE directory: `~/community/mintlify-docs/acp-java-sdk/reference/` |
| 22 | +- [ ] CREATE directory: `~/community/mintlify-docs/acp-java-sdk/tutorial/` |
| 23 | + |
| 24 | +**Exit criteria**: |
| 25 | +- [ ] mint.json validates and includes ACP Java SDK navigation |
| 26 | +- [ ] Directory structure created |
| 27 | +- [ ] Update `ROADMAP.md` checkboxes |
| 28 | + |
| 29 | +**Deliverables**: Site navigation and directory scaffolding |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +### Step 1.2: Index Page |
| 34 | + |
| 35 | +**Entry criteria**: |
| 36 | +- [ ] Step 1.1 complete |
| 37 | +- [ ] Read: `~/community/mintlify-docs/claude-agent-sdk/index.md` (template) |
| 38 | +- [ ] Read: `~/acp/acp-java/README.md` (source material) |
| 39 | + |
| 40 | +**Work items**: |
| 41 | +- [ ] CREATE `~/community/mintlify-docs/acp-java-sdk/index.md` (~120 lines) |
| 42 | +- [ ] Content: Overview, three-API-styles table, quick start (client + annotation-based agent), CardGroup to Reference + Tutorial, resource links |
| 43 | + |
| 44 | +**Exit criteria**: |
| 45 | +- [ ] Index page renders in dev preview |
| 46 | +- [ ] Code examples match SDK README |
| 47 | +- [ ] Update `ROADMAP.md` checkboxes |
| 48 | + |
| 49 | +**Deliverables**: `acp-java-sdk/index.md` |
| 50 | + |
| 51 | +--- |
| 52 | + |
| 53 | +### Step 1.3: Tutorial Index Page |
| 54 | + |
| 55 | +**Entry criteria**: |
| 56 | +- [ ] Step 1.1 complete |
| 57 | +- [ ] Read: `~/community/mintlify-docs/claude-agent-sdk/tutorial/index.md` (template) |
| 58 | + |
| 59 | +**Work items**: |
| 60 | +- [ ] CREATE `~/community/mintlify-docs/acp-java-sdk/tutorial/index.md` (~60 lines) |
| 61 | +- [ ] Content: Overview, prerequisites, 3-part structure table, getting the code |
| 62 | + |
| 63 | +**Exit criteria**: |
| 64 | +- [ ] Tutorial index renders and links resolve |
| 65 | +- [ ] Update `ROADMAP.md` checkboxes |
| 66 | + |
| 67 | +**Deliverables**: `acp-java-sdk/tutorial/index.md` |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +### Step 1.4: Priority Tutorial Pages (10 Pages) |
| 72 | + |
| 73 | +**Entry criteria**: |
| 74 | +- [ ] Step 1.3 complete |
| 75 | +- [ ] Read: `~/community/mintlify-docs/claude-agent-sdk/tutorial/01-hello-world.md` (template) |
| 76 | +- [ ] VERIFY: `cd ~/projects/acp-java-tutorial && ./mvnw compile -pl module-01-first-contact,module-05-streaming-updates,module-12-echo-agent,module-13-agent-handlers,module-14-sending-updates,module-15-agent-requests,module-16-in-memory-testing,module-28-zed-integration,module-29-jetbrains-integration,module-30-vscode-integration -q` |
| 77 | + |
| 78 | +**Work items**: |
| 79 | +- [ ] CREATE `tutorial/01-first-contact.md` — ACP client basics (module-01) |
| 80 | +- [ ] CREATE `tutorial/05-streaming-updates.md` — Receiving real-time updates (module-05) |
| 81 | +- [ ] CREATE `tutorial/12-echo-agent.md` — Building your first agent (module-12) |
| 82 | +- [ ] CREATE `tutorial/13-agent-handlers.md` — All handler types (module-13) |
| 83 | +- [ ] CREATE `tutorial/14-sending-updates.md` — Agent-side streaming (module-14) |
| 84 | +- [ ] CREATE `tutorial/15-agent-requests.md` — File and permission requests (module-15) |
| 85 | +- [ ] CREATE `tutorial/16-in-memory-testing.md` — Testing without subprocesses (module-16) |
| 86 | +- [ ] CREATE `tutorial/28-zed-integration.md` — Running agents in Zed (module-28) |
| 87 | +- [ ] CREATE `tutorial/29-jetbrains-integration.md` — Running agents in JetBrains (module-29) |
| 88 | +- [ ] CREATE `tutorial/30-vscode-integration.md` — Running agents in VS Code (module-30) |
| 89 | + |
| 90 | +Each page follows template structure: |
| 91 | +- What You'll Learn |
| 92 | +- The Code (with explanation) |
| 93 | +- Source Code GitHub link |
| 94 | +- Run Command |
| 95 | +- Next Module |
| 96 | + |
| 97 | +**Exit criteria**: |
| 98 | +- [ ] All 10 pages render in dev preview |
| 99 | +- [ ] Code examples match actual tutorial source |
| 100 | +- [ ] All cross-links resolve |
| 101 | +- [ ] Update `ROADMAP.md` checkboxes |
| 102 | + |
| 103 | +**Deliverables**: 10 tutorial pages in `acp-java-sdk/tutorial/` |
| 104 | + |
| 105 | +--- |
| 106 | + |
| 107 | +### Step 1.5: API Reference Page |
| 108 | + |
| 109 | +**Entry criteria**: |
| 110 | +- [ ] Step 1.1 complete |
| 111 | +- [ ] Read: `~/community/mintlify-docs/claude-agent-sdk/reference/java.md` (template) |
| 112 | +- [ ] Read: `~/acp/acp-java/README.md` (source material) |
| 113 | +- [ ] Read: `~/acp/acp-java/acp-agent-support/README.md` (source material) |
| 114 | + |
| 115 | +**Work items**: |
| 116 | +- [ ] CREATE `~/community/mintlify-docs/acp-java-sdk/reference/java.md` (~500 lines) |
| 117 | +- [ ] Sections: Installation, Three-API comparison, Client API, Agent API (annotation/sync/async), Protocol types, Capabilities, Transports, Errors, Test utilities |
| 118 | + |
| 119 | +**Exit criteria**: |
| 120 | +- [ ] Reference page renders in dev preview |
| 121 | +- [ ] All code examples verified against SDK |
| 122 | +- [ ] Update `ROADMAP.md` checkboxes |
| 123 | + |
| 124 | +**Deliverables**: `acp-java-sdk/reference/java.md` |
| 125 | + |
| 126 | +--- |
| 127 | + |
| 128 | +### Step 1.6: Stage 1 Review |
| 129 | + |
| 130 | +**Entry criteria**: |
| 131 | +- [ ] Steps 1.1-1.5 complete |
| 132 | + |
| 133 | +**Work items**: |
| 134 | +- [ ] RUN `~/community/mintlify-docs/dev-preview.sh` to verify all pages render |
| 135 | +- [ ] VERIFY all cross-links work (index → tutorial → reference) |
| 136 | +- [ ] VERIFY code examples match actual tutorial source |
| 137 | +- [ ] CHECK for forbidden marketing language |
| 138 | +- [ ] VERIFY no internal implementation details exposed |
| 139 | + |
| 140 | +**Exit criteria**: |
| 141 | +- [ ] All pages render without errors |
| 142 | +- [ ] Zero forbidden-language violations |
| 143 | +- [ ] All code examples match working tutorial code |
| 144 | +- [ ] Update `ROADMAP.md` checkboxes |
| 145 | + |
| 146 | +--- |
| 147 | + |
| 148 | +## Stage 2: Tutorial READMEs + SDK Updates |
| 149 | + |
| 150 | +### Step 2.1: Lightweight Module READMEs (10 Priority Modules) |
| 151 | + |
| 152 | +**Entry criteria**: |
| 153 | +- [ ] Stage 1 complete |
| 154 | +- [ ] Read: `~/community/claude-agent-sdk-java-tutorial/module-01-hello-world/README.md` (template) |
| 155 | + |
| 156 | +**Work items**: |
| 157 | +- [ ] CREATE README.md for module-01-first-contact (5-6 lines) |
| 158 | +- [ ] CREATE README.md for module-05-streaming-updates |
| 159 | +- [ ] CREATE README.md for module-12-echo-agent |
| 160 | +- [ ] CREATE README.md for module-13-agent-handlers |
| 161 | +- [ ] CREATE README.md for module-14-sending-updates |
| 162 | +- [ ] CREATE README.md for module-15-agent-requests |
| 163 | +- [ ] CREATE README.md for module-16-in-memory-testing |
| 164 | +- [ ] UPDATE README.md for module-28 — add Mintlify link at top |
| 165 | +- [ ] UPDATE README.md for module-29 — add Mintlify link at top |
| 166 | +- [ ] UPDATE README.md for module-30 — add Mintlify link at top |
| 167 | + |
| 168 | +**Exit criteria**: |
| 169 | +- [ ] All 10 modules have README.md files |
| 170 | +- [ ] Mintlify links point to correct pages |
| 171 | +- [ ] Update `ROADMAP.md` checkboxes |
| 172 | + |
| 173 | +**Deliverables**: 7 new READMEs, 3 updated READMEs |
| 174 | + |
| 175 | +--- |
| 176 | + |
| 177 | +### Step 2.2: Fix Tutorial README |
| 178 | + |
| 179 | +**Entry criteria**: |
| 180 | +- [ ] Step 2.1 complete |
| 181 | + |
| 182 | +**Work items**: |
| 183 | +- [ ] UPDATE `~/projects/acp-java-tutorial/README.md` |
| 184 | +- [ ] MOVE modules 03, 04, 06, 09, 11 from "Coming Soon" to active (they have source code) |
| 185 | +- [ ] ADD Mintlify docs link at top |
| 186 | +- [ ] REORGANIZE into 3-part structure: Client → Agent → IDE Integration |
| 187 | + |
| 188 | +**Exit criteria**: |
| 189 | +- [ ] No modules with source code listed as "Coming Soon" |
| 190 | +- [ ] Mintlify link works |
| 191 | +- [ ] Update `ROADMAP.md` checkboxes |
| 192 | + |
| 193 | +**Deliverables**: Updated tutorial README |
| 194 | + |
| 195 | +--- |
| 196 | + |
| 197 | +### Step 2.3: SDK README Updates |
| 198 | + |
| 199 | +**Entry criteria**: |
| 200 | +- [ ] Step 2.2 complete |
| 201 | + |
| 202 | +**Work items**: |
| 203 | +- [ ] UPDATE `~/acp/acp-java/README.md` |
| 204 | +- [ ] ADD Mintlify docs link at top of Overview |
| 205 | +- [ ] UPDATE Installation: change `0.9.0-SNAPSHOT` to `0.9.0`, remove snapshots repository XML |
| 206 | + |
| 207 | +**Exit criteria**: |
| 208 | +- [ ] Version references updated |
| 209 | +- [ ] Mintlify link present |
| 210 | +- [ ] Update `ROADMAP.md` checkboxes |
| 211 | + |
| 212 | +**Deliverables**: Updated SDK README |
| 213 | + |
| 214 | +--- |
| 215 | + |
| 216 | +### Step 2.4: CHANGELOG for 0.9.0 |
| 217 | + |
| 218 | +**Entry criteria**: |
| 219 | +- [ ] Step 2.3 complete |
| 220 | + |
| 221 | +**Work items**: |
| 222 | +- [ ] UPDATE `~/acp/acp-java/CHANGELOG.md` |
| 223 | +- [ ] REPLACE "[Unreleased]" with "[0.9.0] - 2026-02-XX" |
| 224 | +- [ ] EXPAND with full feature list from SDK development |
| 225 | + |
| 226 | +**Exit criteria**: |
| 227 | +- [ ] CHANGELOG reflects 0.9.0 release |
| 228 | +- [ ] All major features listed |
| 229 | +- [ ] Update `ROADMAP.md` checkboxes |
| 230 | + |
| 231 | +**Deliverables**: Updated CHANGELOG |
| 232 | + |
| 233 | +--- |
| 234 | + |
| 235 | +### Step 2.5: Stage 2 Review |
| 236 | + |
| 237 | +**Entry criteria**: |
| 238 | +- [ ] Steps 2.1-2.4 complete |
| 239 | + |
| 240 | +**Work items**: |
| 241 | +- [ ] VERIFY GitHub rendering of all module READMEs |
| 242 | +- [ ] CLICK all cross-links (SDK README → tutorial modules → Mintlify) |
| 243 | +- [ ] CONFIRM `./mvnw compile` passes for tutorial project |
| 244 | + |
| 245 | +**Exit criteria**: |
| 246 | +- [ ] All links resolve |
| 247 | +- [ ] Tutorial compiles |
| 248 | +- [ ] Update `ROADMAP.md` checkboxes |
| 249 | + |
| 250 | +--- |
| 251 | + |
| 252 | +## Stage 3: Post-Launch Completion (Not Blocking Release) |
| 253 | + |
| 254 | +### Step 3.1: Remaining Mintlify Tutorial Pages (14 Pages) |
| 255 | + |
| 256 | +**Work items**: |
| 257 | +- [ ] CREATE pages for modules: 02, 03, 04, 06, 07, 08, 09, 10, 11, 17, 18, 19, 21, 22 |
| 258 | +- [ ] UPDATE mint.json navigation with expanded tutorial groups |
| 259 | + |
| 260 | +--- |
| 261 | + |
| 262 | +### Step 3.2: Remaining Tutorial Module READMEs (14 Modules) |
| 263 | + |
| 264 | +**Work items**: |
| 265 | +- [ ] CREATE READMEs for all remaining modules with source code |
| 266 | + |
| 267 | +--- |
| 268 | + |
| 269 | +### Step 3.3: SDK Module READMEs |
| 270 | + |
| 271 | +**Work items**: |
| 272 | +- [ ] CREATE lightweight READMEs for: acp-core, acp-annotations, acp-test, acp-websocket-jetty |
| 273 | + |
| 274 | +--- |
| 275 | + |
| 276 | +### Step 3.4: Enhancements |
| 277 | + |
| 278 | +**Work items**: |
| 279 | +- [ ] ADD architecture diagram to Mintlify index |
| 280 | +- [ ] ADD Gradle installation instructions to reference page |
| 281 | + |
| 282 | +--- |
| 283 | + |
| 284 | +## Execution Order (Stage 1 Priority) |
| 285 | + |
| 286 | +1. mint.json + directory scaffolding (unblocks everything) |
| 287 | +2. Index page + tutorial index (site structure) |
| 288 | +3. Tutorial pages: 12 (echo agent), 28 (Zed), 01 (first contact) — highest impact first |
| 289 | +4. API reference page (largest single item) |
| 290 | +5. Remaining 7 tutorial pages |
| 291 | +6. Stage 1 review |
| 292 | + |
| 293 | +## Verification |
| 294 | + |
| 295 | +- `~/community/mintlify-docs/dev-preview.sh` — all pages render |
| 296 | +- Every code example matches actual tutorial source |
| 297 | +- All cross-links: SDK README → tutorial modules → Mintlify |
| 298 | +- `./mvnw compile` passes for tutorial project |
| 299 | + |
| 300 | +## Writing Agents |
| 301 | + |
| 302 | +| Agent | Role | |
| 303 | +|-------|------| |
| 304 | +| `~/.claude/agents/technical-writer.md` | Primary — writes Mintlify pages and READMEs | |
| 305 | +| `~/.claude/agents/doc-reviewer.md` | Review — validates against style guide | |
| 306 | +| `~/.claude/agents/tutorial-code-sync.md` | Sync — ensures code examples match tutorial source | |
| 307 | + |
| 308 | +## Style Principles |
| 309 | + |
| 310 | +- Direct, plain-spoken, unadorned |
| 311 | +- Assume reader competence |
| 312 | +- Structure: context, mechanism, consequence |
| 313 | +- Forbidden: exciting, game-changing, best-in-class, seamlessly, powerful, intuitive, revolutionary, cutting-edge |
| 314 | +- Short paragraphs (3-4 sentences max), tables for comparisons, code blocks liberally |
| 315 | +- Accuracy over aesthetics |
| 316 | + |
| 317 | +## Conventions |
| 318 | + |
| 319 | +### Commit Convention |
| 320 | + |
| 321 | +``` |
| 322 | +Step X.Y: Brief description of what was done |
| 323 | +``` |
| 324 | + |
| 325 | +### Code-First Workflow |
| 326 | + |
| 327 | +1. Verify tutorial code compiles: `./mvnw compile -pl module-XX-* -q` |
| 328 | +2. THEN write docs based on working code |
| 329 | +3. Code in docs must match working tutorial code exactly |
0 commit comments