Repository navigation
docs(guides): add the transports guide - #567
Open
chopmob-cloud wants to merge 2 commits into
Open
chopmob-cloud wants to merge 2 commits into
chopmob-cloud wants to merge 2 commits into
Conversation
chopmob-cloud
force-pushed
the
docs/534-transports-guide
branch
from
November 19, 2026 20:38
cd58e92 to
4f0bddf
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Serves a2aproject#534 (part of a2aproject#521). Covers choosing a binding, JSON-RPC and REST, gRPC, serving several bindings from one handler, TLS, and SLIMRPC. Every snippet is included from a compiled file through pymdownx.snippets with check_paths on, so a broken include fails `mkdocs build --strict`. The gRPC and TLS regions needed markers added to the examples; the JSON-RPC/REST snippet is the existing `routers` region. Each binding names the crate and its feature flag. The TLS section records the rustls-tls (default) versus native-tls choice for a2a-server and a2a-client. SLIMRPC has no runnable example in this repository, so its section points at the crate README and its e2e test rather than inventing a snippet from nothing. That is the one place the guide falls short of "every snippet from a compiled file", and it is called out here and in the PR rather than papered over. Verified: `mkdocs build --strict` passes and the rendered page contains each snippet; pointing a snippet at a missing file fails the build with SnippetMissingError (negative control). `cargo check -p examples` and `cargo fmt -p examples --check` are clean. Refs a2aproject#534 Signed-off-by: AlgoVoi <chopmob@gmail.com>
a2aproject/a2a-cli removed specification/SPEC.md in a2aproject#161, so the link in the vendored README returns 404 and fails the docs link check. The link is pre-existing and unrelated to the transports guide, but it fails the same Docs workflow this branch touches, so it is fixed here rather than left red. Point at the published a2a-cli documentation, which is where the command reference now lives. Signed-off-by: AlgoVoi <chopmob@gmail.com>
chopmob-cloud
force-pushed
the
docs/534-transports-guide
branch
from
November 19, 2026 20:50
4f0bddf to
54a8f7a
Compare
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Serves #534 (part of #521). Adds
docs/guides/transports.mdand a Guides nav section.What it covers
a2a-server,a2a-clientrustls-tls(default) /native-tlsa2a-grpc,a2a-pb(proto/a2a.proto)RequestHandlera2a_server::tlsrustls-tls(default) /native-tlsa2a-slimrpcSnippets
Included from compiled files via
pymdownx.snippetswithcheck_paths: true:examples/src/helloworld/server.rs:routers— existing region, JSON-RPC + REST + card routerexamples/src/helloworld/server.rs:grpc— new marker around thea2a-grpcserviceexamples/src/helloworld_tls/server.rs:tls-config— new marker around the rustls HTTP/gRPC configThe one gap, stated plainly
SLIMRPC has no runnable example in this repository — only
src/, aREADME.md, andtests/e2e.rs. Rather than invent a snippet, its section points at the crate README (which documents the target format and theServiceParamsidentity keys) and the e2e test. That is the only place this falls short of "every snippet is included from a compiled file".If you would prefer a real SLIMRPC example in
examples/and a snippet from it, say so and I will add one, but that is a larger change than a docs page and I did not want to guess at the intended example shape.Verification
mkdocs build --strict— exit 0site/guides/transports/index.htmlcontains each snippet's code (jsonrpc_router,rest_router,A2aServiceServer,GrpcHandler,load_rustls_config,TlsIncoming); no--8<--markers leakedexamples/src/nope/missing.rsfails the build withSnippetMissingError— the gate is live, not decorativecargo check -p examples— cleancargo fmt -p examples --check— exit 0Refs #534.