16 Commits

Author SHA1 Message Date
Holt Skinner
8dda73b3b4
docs: Add Rust SDK to list of official SDKs (#1729)
- Change table header to include repository instead of stability (all
are currently stable)

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Sampath Kumar <sam1990kumar@gmail.com>
2026-04-09 08:38:46 +00:00
Luca Muscariello
b86d8bb2ed
docs: clean up documentation build chain and fix broken links (#1400)
- Move a2a.proto to specification/ root
- Update build scripts and macros to support new proto location
- Fix broken internal links and anchor references in specification.md
- Update .gitignore to properly exclude generated SDK docs
- Configure Sphinx to suppress external SDK warnings
- Fix MkDocs redirects and Python SDK toctree structure

---------

Signed-off-by: Luca Muscariello <muscariello@ieee.org>
2026-01-29 21:00:02 +01:00
Ivan Shymko
bb527d4299
docs: Bring back Python SDK reference (#1415)
Currently [`SDK Reference >
Python`](https://a2a-protocol.org/latest/sdk/python.md) link gives 404:

<img width="1138" height="308" alt="image"
src="https://github.com/user-attachments/assets/2bd3bda0-0536-4450-8e82-5ec9ee5ce044"
/>

1. Fix the link to open
[this](https://a2a-protocol.org/latest/sdk/python/api/index.html)
instead. This was setup in #949 and is generated automatically from the
latest docs. Looks like it was accidentally changed to `python.md` (the
one not used ever before, it used to be `python/index.md`) in #1160.
2. Fix redirect to use absolute URL with `latest`. This is required due
to https://github.com/mkdocs/mkdocs-redirects/issues/18, current way
isn't going to work. `v0.3.0` tag of the website (the one you get after
clicking `Latest Released Version` from
[here](https://a2a-protocol.org/latest/specification/)) doesn't have the
generated documentation either way, see
[here](https://github.com/a2aproject/A2A/tree/gh-pages/v0.3.0/sdk/python).
3. Replace `Google LLC` with `The Linux Foundation` in the generated SDK
reference.
4. Update copyright year in both places.

Tested via `mkdocs serve`.

Fixes #1347.
2026-01-26 10:12:40 -06:00
Holt Skinner
f74fe490a8 docs: Fix broken link to Python SDK Docs 2025-12-05 14:19:17 -06:00
Darrel
b078419954
docs(spec): Large refactor of specification to separate application protocol definition from mapping to transports. (#1160)
Related to #1151 

Fixes https://github.com/a2aproject/A2A/issues/998
Fixes https://github.com/a2aproject/A2A/issues/1091
Fixes https://github.com/a2aproject/A2A/issues/1072
Fixes https://github.com/a2aproject/A2A/issues/1058
Fixes https://github.com/a2aproject/A2A/issues/975
Fixes https://github.com/a2aproject/A2A/issues/1105
Fixes https://github.com/a2aproject/A2A/issues/989
Fixes https://github.com/a2aproject/A2A/issues/1189
Fixes https://github.com/a2aproject/A2A/issues/1187
Fixes https://github.com/a2aproject/A2A/issues/1177
Fixes https://github.com/a2aproject/A2A/issues/1180
Fixes https://github.com/a2aproject/A2A/issues/1172



In order to more effectively describe the A2A protocol in a consistent
way across different protocols, this PR refactors the specification to
describe the application protocol in a transport agnostic way, and then
have separate sections that describe how each of the transports map to
the abstract application protocol. To see a preview of what it looks
like you can go here
https://purple-moss-0838db51e.3.azurestaticapps.net/specification/

The goal of the TSC is to use the changes in this PR as the baseline for
a v1.0 Release Candidate. This will give SDK maintainers an stable
document to validate the changes in the specification through
implementations before v1.0 release.

There are many pending feature requests for the A2A specifications that
the TSC are supportive of. However, getting a stable, consistent,
unambiguous, multi-protocol specification is necessary before additional
features can be added safely.

## Document Restructuring 

- [A2A
Operations](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#3-a2a-protocol-operations)
are described independent of wire protocol
- [Protocol Data
Model](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#4-protocol-data-model)
is described using protobuf as source of truth. All other serializations
are derived from that.
- Protocol bindings (formerly described as transports) are now described
in their own sections
-
[JSON-RPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#9-json-rpc-protocol-binding)
-
[gRPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#10-grpc-protocol-binding)
-
[HTTP](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#11-httpjsonrest-protocol-binding)
- [Operation Parameters
](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#32-operation-parameter-objects)
describe structures reused across different operations
- [Operation
Semantics](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#33-operation-semantics)
describe common behavior patterns across operations

## New Sections

- [Requirements
Language](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#21-requirements-language)
- [Capability
Validation](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#334-capability-validation)
- [Abstract description of error
handling](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#332-error-handling)
- [Abstract description of
"headers"](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#325-headers)
-
[Extensions](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#46-extensions)
-
[Versioning](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#36-versioning)
- [Custom Binding
Guidelines](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#12-custom-binding-guidelines)
- [JSON Field Naming
Conventions](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#54-json-field-naming-convention)
- [Data Type
Conventions](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#55-data-type-conventions)
- [Security
Considerations](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#77-security-considerations)
- [Agent Card
Signing](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#84-agent-card-signing)
- [IANA
Considerations](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#13-iana-considerations)

## Protocol Clarifications

- Defining order for events returned from [Stream
Message](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#312-stream-message)
- [JSON
Examples](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#416-filepart)
provided for protobuf definitions of data model objects that previously
used discriminators
- Clarification of returned errors where multiple are applicable. e.g.
[Cancel
Task](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#315-cancel-task)
- Defined returned events and usage scenarios for
[Resubscribe](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#316-resubscribe-to-task)
- Defined protocol binding for errors using protocol native capabilities
for all bindings
-
[JSON-RPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#94-error-handling)
-
[gRPC](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#104-error-handling)
-
[HTTP](https://purple-moss-0838db51e.3.azurestaticapps.net/specification/#115-error-handling)
  
## Artifact Generation

The scripts have been changed to enable a2a.json to be generated from
the a2a.proto so that a2a.proto and specification.md are the only
normative source. Additional work is required to align the generated
a2a.json with the original one.

Release-As: 1.0

---------

Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Signed-off-by: Luca Muscariello <lumuscar@cisco.com>
Co-authored-by: Luca Muscariello <muscariello@ieee.org>
Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Sam Betts <1769706+Tehsmash@users.noreply.github.com>
2025-11-20 14:52:09 -05:00
Ivan Cheung
7c8181e045
docs: Updated references to Go (#1202) 2025-11-11 15:37:02 -06:00
Holt Skinner
1c1d72056c
docs: Restructure TOC under Topics (#1060)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-09-11 12:42:32 -05:00
Holt Skinner
586bd645e9 docs: Remove sdk/python/README.md 2025-07-31 20:09:29 +01:00
Holt Skinner
ced1f6fb3d
docs: Update Python SDK Docs to use Sphinx (#949)
Fixes #950
2025-07-31 20:05:24 +01:00
alan blount
4a0d92eff7
docs: Homepage Style Updates (#794)
- Minor changes to above-the-fold homepage content
- Add YouTube Intro Video
- Add specific modules to Python SDK Docs to decrease compile time

---------

Co-authored-by: Holt Skinner <13262395+holtskinner@users.noreply.github.com>
Co-authored-by: Holt Skinner <holtskinner@google.com>
2025-06-30 17:36:22 +00:00
Holt Skinner
08132ac5c7
docs: Repo Link Updates (#780) 2025-06-23 21:34:48 +02:00
Holt Skinner
fab2b0deeb chore: Add custom CSS Styles to SDK Docs 2025-06-03 12:30:15 -05:00
Holt Skinner
729988a3f5
refactor: Remove Samples/Demo/test directories and change references to google/A2A (#668) 2025-05-27 16:31:32 -05:00
xie qizhuo
563da7e3fd
docs: corrected a2a-sdk gitHub repository link in documentation (#667) 2025-05-27 13:07:14 -05:00
Holt Skinner
081fa20bdf
docs: Update SDK Reference page (#603)
- Move SDK Reference before Tutorial in TOC
- Add `pip install` command to SDK Reference page
2025-05-20 07:43:19 -07:00
Holt Skinner
67472e9908
docs: Python SDK Initial Doc Generation (#570)
Create Python SDK Documentation using mkdocstring
2025-05-20 07:38:15 -07:00