Commit 3ac8d5b
docs: align agent example format with official Claude Code documentation (#119)
## Summary
- Aligns all `<example>` blocks in agent development documentation and
agents with the official Claude Code documentation format
- Updates template and examples in `triggering-examples.md`
- Updates documented template format in `agent-creator.md`
- Converts two-assistant-line examples to single-assistant-line format
in all 3 agents
## Problem
Fixes #117
The plugin's internal documentation and agents were using a
two-assistant-line example format that differed from the official Claude
Code documentation:
| Aspect | Official Docs | This Plugin (Before) |
|--------|---------------|---------------------|
| Assistant lines | 1 (invocation only) | 2 (response + invocation) |
| Commentary position | After invocation | Between responses |
## Solution
Aligned all examples with the official format:
- Single assistant line showing the agent invocation
- Commentary positioned after the assistant line
### Files Changed
| File | Changes |
|------|---------|
| `triggering-examples.md` | Updated format template and all example
types (Type 2, 3, 4, Template Library) |
| `agent-creator.md` | Updated documented template format |
| `plugin-validator.md` | Converted Examples 1, 3, 4 to single-line
format |
| `skill-reviewer.md` | Converted Example 1 to single-line format |
### Alternatives Considered
Documenting the intentional difference rather than aligning was
considered, but alignment with official documentation was chosen for:
1. Consistency with official Claude Code patterns
2. Reduced cognitive load for users referencing both sources
3. Simpler format that's sufficient for demonstrating triggers
## Testing
- [x] All modified files pass markdownlint
- [x] Examples follow official format structure
- [x] No broken references
---
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude <noreply@anthropic.com>1 parent ba5cdb8 commit 3ac8d5b
4 files changed
Lines changed: 29 additions & 65 deletions
File tree
- plugins/plugin-dev
- agents
- skills/agent-development/references
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | | - | |
| 72 | + | |
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
| |||
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | | - | |
93 | 92 | | |
94 | 93 | | |
95 | 94 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | 12 | | |
14 | 13 | | |
15 | 14 | | |
| |||
24 | 23 | | |
25 | 24 | | |
26 | 25 | | |
27 | | - | |
| 26 | + | |
28 | 27 | | |
29 | 28 | | |
30 | 29 | | |
31 | | - | |
32 | 30 | | |
33 | 31 | | |
34 | 32 | | |
35 | 33 | | |
36 | 34 | | |
37 | | - | |
| 35 | + | |
38 | 36 | | |
39 | 37 | | |
40 | 38 | | |
41 | | - | |
42 | 39 | | |
43 | 40 | | |
44 | 41 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | 12 | | |
14 | 13 | | |
15 | 14 | | |
| |||
Lines changed: 23 additions & 54 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
18 | 17 | | |
19 | 18 | | |
20 | 19 | | |
| |||
58 | 57 | | |
59 | 58 | | |
60 | 59 | | |
61 | | - | |
| 60 | + | |
62 | 61 | | |
63 | | - | |
| 62 | + | |
64 | 63 | | |
65 | 64 | | |
66 | 65 | | |
67 | | - | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
72 | | - | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
78 | 69 | | |
79 | 70 | | |
80 | 71 | | |
| |||
104 | 95 | | |
105 | 96 | | |
106 | 97 | | |
107 | | - | |
108 | | - | |
109 | | - | |
110 | | - | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
115 | | - | |
116 | | - | |
117 | | - | |
118 | | - | |
119 | | - | |
120 | | - | |
121 | | - | |
122 | | - | |
123 | 98 | | |
124 | 99 | | |
125 | 100 | | |
| |||
145 | 120 | | |
146 | 121 | | |
147 | 122 | | |
148 | | - | |
| 123 | + | |
149 | 124 | | |
150 | 125 | | |
151 | 126 | | |
152 | 127 | | |
153 | | - | |
154 | 128 | | |
155 | 129 | | |
156 | 130 | | |
| |||
162 | 136 | | |
163 | 137 | | |
164 | 138 | | |
165 | | - | |
| 139 | + | |
166 | 140 | | |
167 | | - | |
168 | | - | |
| 141 | + | |
169 | 142 | | |
170 | | - | |
171 | 143 | | |
172 | 144 | | |
173 | 145 | | |
| |||
179 | 151 | | |
180 | 152 | | |
181 | 153 | | |
182 | | - | |
| 154 | + | |
183 | 155 | | |
184 | 156 | | |
185 | 157 | | |
186 | 158 | | |
187 | | - | |
188 | 159 | | |
189 | 160 | | |
190 | 161 | | |
| |||
215 | 186 | | |
216 | 187 | | |
217 | 188 | | |
218 | | - | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
219 | 193 | | |
220 | 194 | | |
221 | 195 | | |
222 | 196 | | |
223 | 197 | | |
224 | | - | |
| 198 | + | |
225 | 199 | | |
226 | | - | |
| 200 | + | |
227 | 201 | | |
228 | | - | |
229 | 202 | | |
230 | 203 | | |
231 | 204 | | |
| |||
267 | 240 | | |
268 | 241 | | |
269 | 242 | | |
270 | | - | |
| 243 | + | |
271 | 244 | | |
272 | | - | |
| 245 | + | |
273 | 246 | | |
274 | 247 | | |
275 | 248 | | |
| |||
350 | 323 | | |
351 | 324 | | |
352 | 325 | | |
353 | | - | |
| 326 | + | |
354 | 327 | | |
355 | 328 | | |
356 | 329 | | |
357 | | - | |
358 | 330 | | |
359 | 331 | | |
360 | 332 | | |
| |||
373 | 345 | | |
374 | 346 | | |
375 | 347 | | |
376 | | - | |
| 348 | + | |
377 | 349 | | |
378 | 350 | | |
379 | 351 | | |
380 | | - | |
381 | 352 | | |
382 | 353 | | |
383 | 354 | | |
| |||
396 | 367 | | |
397 | 368 | | |
398 | 369 | | |
399 | | - | |
| 370 | + | |
400 | 371 | | |
401 | 372 | | |
402 | 373 | | |
403 | | - | |
404 | 374 | | |
405 | 375 | | |
406 | 376 | | |
| |||
419 | 389 | | |
420 | 390 | | |
421 | 391 | | |
422 | | - | |
| 392 | + | |
423 | 393 | | |
424 | 394 | | |
425 | 395 | | |
426 | | - | |
427 | 396 | | |
428 | 397 | | |
429 | 398 | | |
| |||
0 commit comments