Commit 8bf5313
Add developer guide and documentation for A2A sample (#30)
* Add comprehensive developer guide for A2A sample
This adds a 9-document developer guide for the Cymbal Retail Agent sample:
- SKILLS.md: AI assistant context for Claude Code, Gemini CLI, Cursor
- DEVELOPER_GUIDE.md: Main entry point with architecture diagram
- docs/01-architecture.md: System components and data flow
- docs/02-adk-agent.md: ADK framework patterns, tools, callbacks
- docs/03-ucp-integration.md: UCP capabilities and negotiation
- docs/04-commerce-flows.md: Checkout state machine and payment
- docs/05-frontend.md: React components and A2A client
- docs/06-extending.md: How to customize the sample
- docs/07-operations.md: Testing and troubleshooting
* Enhance developer guide with diagrams, user journeys, and explanations
- Rename 07-operations.md to 07-testing-guide.md for clarity
- Add Mock Store architecture section with replacement guide
- Major rewrite of extending guide with 4 user journeys
- Add "Why" sections throughout for better readability
- Add 9 new Mermaid diagrams across all docs
- Update cross-references in DEVELOPER_GUIDE.md and SKILLS.md
* Add diagrams and update developer documentation
- Add 17 diagrams to assets/diagrams/ for visual documentation
- Update docs to use images instead of Mermaid blocks
- Add figure captions and proper alignment for all diagrams
* Add architecture diagram to DEVELOPER_GUIDE.md
* Optimize README and DEVELOPER_GUIDE flow
- Add "Next Steps" section to README with links to developer docs
- Remove redundant "Components" and "Mock Store" sections from README
- Add "About This Guide" section to DEVELOPER_GUIDE with prerequisites
- Remove duplicate Quick Start from DEVELOPER_GUIDE
Creates smooth developer journey: README (landing) → DEVELOPER_GUIDE
(technical entry) → docs/ (deep dives) with forward-only references.
* Add glossary, production notes, and documentation improvements
* Remove .scripts folder from tracking
* Test WebP format for glossary diagrams (86-90% size reduction)
* Convert images to WebP and GIF to MP4 (94% size reduction)
* Use animated WebP for demo (71% smaller than GIF)
* Update SKILLS.md and add references in README and dev guide
* update diagram
---------
Co-authored-by: Krishna Thota <kcthota@google.com>1 parent 44b1768 commit 8bf5313
42 files changed
Lines changed: 2714 additions & 39 deletions
File tree
- a2a
- assets
- diagrams
- docs
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
106 | | - | |
| 106 | + | |
107 | 107 | | |
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
112 | | - | |
| 112 | + | |
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
| |||
139 | 139 | | |
140 | 140 | | |
141 | 141 | | |
142 | | - | |
| 142 | + | |
143 | 143 | | |
144 | 144 | | |
145 | 145 | | |
| |||
158 | 158 | | |
159 | 159 | | |
160 | 160 | | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
161 | 174 | | |
162 | 175 | | |
163 | 176 | | |
| |||
177 | 190 | | |
178 | 191 | | |
179 | 192 | | |
180 | | - | |
181 | | - | |
182 | | - | |
183 | | - | |
184 | | - | |
185 | | - | |
186 | | - | |
187 | | - | |
188 | | - | |
189 | | - | |
190 | | - | |
191 | | - | |
192 | | - | |
193 | | - | |
194 | | - | |
195 | | - | |
196 | | - | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
203 | | - | |
204 | | - | |
205 | | - | |
206 | | - | |
207 | | - | |
208 | | - | |
209 | | - | |
210 | | - | |
211 | | - | |
212 | | - | |
213 | | - | |
214 | 193 | | |
215 | 194 | | |
216 | 195 | | |
| |||
0 commit comments