docs(a2a): document A2A SDK 0.3/1.0 compatibility#1925
Conversation
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
koverholt
left a comment
There was a problem hiding this comment.
Thanks @mykytanetipa for the PR and additions. The technical content is accurate against a2a-sdk 1.x, and the deprecation framing is clear.
Before we review, I'd like to understand a few things:
Release timing / does the described behavior exist in a released ADK yet?
As far as I can tell from public adk-python:
_compat.pyisn't in main or any released ADK Python versionpyproject.tomlstill pinsa2a-sdk>=0.3.4,<0.4- Issue google/adk-python#5056 is still open and PR google/adk-python#5917 was closed.
Is this blocked by some future release of ADK Python? And do you know the timing?
Audience / scope: is this user documentation or an internal design doc?
The page documents the private module _compat.py which is never imported by application code. There is no action in user's code, and much of this doc overlaps with the existing a2a-python v1.0 migration guide.
Would it make more sense to have only a short user-facing note on the existing A2A overview page that links to the migration guide rather than a new top-level page in ADK docs that we need to maintain, which mainly focuses on a2a-sdk internals?
I have many other comments on the proposed doc as well, but those only really apply if we need to publish / maintain these a2a-sdk docs in the ADK docs, which I would recommend against and would instead recommend just including a callout and link on an existing A2A page in these docs.
|
Thanks @koverholt. Quick update on the two blocking points you raised: Released / version constraint: Both are now resolved in ADK Python 2.5.0:
Scope: I took your recommendation. Rather than a standalone page documenting the a2a-sdk internals, I've reduced this PR to a small informational callout on the existing Introduction to A2A (docs/a2a/intro.md) page that notes the 0.3.x/1.x.x compatibility and links out to the a2a-python v1.0 migration guide. The standalone a2a-sdk-compatibility.md page has been removed. |
koverholt
left a comment
There was a problem hiding this comment.
Thanks for the update and rescoping this to a concise compatibility note and pointing users to the migration guide for the full details. I confirmed the dual-version support has since shipped in ADK 2.5.0, so the note is accurate.
I made a commit to move the note to the two A2A Python quickstart pages, since that's where users will interact with the code, and the intro page is conceptual and not tied to any particular language SDK (Python, Go, Java). LGTM, merging!
This PR adds a new documentation page, docs/a2a/a2a-sdk-compatibility.md, explaining how ADK's A2A integration remains compatible with both major versions of the A2A Python SDK (a2a-sdk 0.3.x and 1.x.x) without requiring changes to ADK application code.