Add developer guide and documentation for A2A sample #30
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
- 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 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 "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.
kthota-g
approved these changes
Jan 23, 2026
wry-ry
approved these changes
Jan 23, 2026
0x8000-0000
approved these changes
Jan 23, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds comprehensive documentation for the UCP A2A sample to help developers understand, extend, and deploy the codebase.
Why
The sample lacked documentation for developers to understand how UCP, A2A, and ADK work together. This PR adds guides designed for different developer personas (junior, senior backend, frontend, devops, AI/ML).
New Files
Main Docs:
a2a/DEVELOPER_GUIDE.md- Main entry point with architecture overview and reading roadmapa2a/SKILLS.md- AI coding assistant context (Claude Code, Gemini CLI, Cursor, Codex)Deep-Dive Guides (
a2a/docs/):00-glossary.md- A2A, UCP, ADK terminology for first-time developers01-architecture.md- System components and data flow02-adk-agent.md- ADK agent tools, callbacks, and prompt engineering03-ucp-integration.md- UCP capabilities and profile negotiation04-commerce-flows.md- Checkout state machine and payment flow05-frontend.md- React components and A2A client06-extending.md- Patterns for adding new features with UCP and ADK07-testing-guide.md- Testing, debugging, and troubleshooting08-production-notes.md- Security gaps and deployment checklistVisuals (
a2a/assets/diagrams/):Updated Files
a2a/README.md- Added Next Steps section with doc links, production warning, SKILLS.md referencea2a/assets/ucp_a2a_demo.webp- Demo converted from GIF to animated WebPImage Optimization
All images converted to WebP format: