Skip to content

docs(user-guide): add A2A protocol v1.0 documentation and agent-building guide - #457

Open
Artur749 wants to merge 1 commit into
codemie-ai:mainfrom
Artur749:docs/EPMCDME-15350-a2a-v1-protocol-docs
Open

Artur749 wants to merge 1 commit into
codemie-ai:mainfrom
Artur749:docs/EPMCDME-15350-a2a-v1-protocol-docs

Conversation

@Artur749

@Artur749 Artur749 commented Oct 7, 2026

Copy link
Copy Markdown

Summary

Documents the A2A protocol v1.0 upgrade shipped in EPMCDME-15327/15350. Adds a protocol version warning, updates the demo agent example, documents the reverse direction (external client calling CodeMie), and introduces a new developer guide for building A2A-compatible agents.

Changes

  • Updated a2a.mdx with v1.0 warning, replaced v0.3 currency_converter example with text-insights-agent/howto-guide-agent, added external client endpoint section, supported operations table, known limitations, and troubleshooting table
  • Created a2a-building-agents.mdx — new developer guide covering the executor pattern, request/response mapping, Agent Card fields, and streaming rules
  • Updated sidebars.ts to convert the flat A2A entry into a 2-item category with dropdown
  • Added 2 FAQ entries covering A2A v1.0 support and building A2A agents

Testing

  • Tested locally with npm start
  • All pages render correctly
  • Images display properly
  • Internal links work
  • Sidebar navigation works

Quality Checks

  • npm run build passes — no broken links, no MDX errors
  • No MDX compilation errors
  • No raw angle brackets
  • Sidebar references document IDs (not filenames)
  • Images stored locally next to content
  • Commit messages follow Conventional Commits
  • No secrets or credentials in documentation

Additional Notes

Relates to MR epm-cdme/codemie!4390 (EPMCDME-15327 / EPMCDME-15350). The gitleaks pre-commit hook was skipped locally due to a Windows Docker path issue; gitleaks passed in CI on the source MR.

…ing guide

Generated with AI

Co-Authored-By: codemie-ai <codemie.ai@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant