Repository navigation
docs: align release materials and fix doc-vs-code drift - #33
Merged
Merged
Conversation
Terminology and structure pass over the published materials: - Unify on host agent / dispatched agent (宿主智能体/被调度智能体) across the README, guides, and diagrams; scenario-bound wording (workbench, OMC, WAIMO, city names) is gone from the release branch. - Drop the three Chinese-only scenario documents (business flow, scenario-specific integration guide, A2A-T dependency note); their reusable content now lives in the README and the five bilingual guides. - Converge docs/en and docs/zh to the same five documents with matching heading structure. - Fix factual drift in the API reference: agentCards defaults to an empty list rather than being required; the negotiation metadata contract is templateUri plus negotiationContext (the stale private negotiation-key description is gone); package-private ContextBuilder is no longer presented as public API. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
Three factual mismatches between the release materials and the actual implementation: - .env.example carried two keys that nothing reads: A2AT_PROMPT_COMPLIANCE_GUARDRAIL_PROVIDER (no such key in the engine or the A2A-T SDK) and A2A_SSL_VERIFY (LoadPsop takes sslVerify as a method parameter, not an environment variable). - The API reference's AgentExecutor example returned an ExecuteResult built via addTextPart - neither exists in the A2A Java SDK. The real contract is void execute(RequestContext, AgentEmitter) with progress and results delivered through the emitter; the example now shows updateStatus and addArtifact. - The integration guide's event example and common-type list named AGENT_STATUS_UPDATE / AGENT_REQUEST / AGENT_RESPONSE, which the engine never emits. The example now switches on TASK_STATUS_CHANGED and the list matches the actually-emitted set, including NEGOTIATION_FAILED, ROUTE_DECISION and WORKFLOW_COMPLETE. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
The documented-callback compile test extracts the code block starting at the 'MetadataContent generated =' marker, so the example must not rely on a variable declared above that marker. Inline the standard template constant instead of the undefined configuredTemplateUri placeholder; the prose reference follows suit. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
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.
Follow-up to the merged architecture PRs (#29, #32): a release-material alignment pass plus a doc-vs-code drift fix.
1. Release-material alignment (b4e05c3)
2. Doc-vs-code drift fixes (7f0e763)
Found by a six-dimension alignment audit (env keys, config builder, callback contracts, facade methods, all method calls in examples, template URIs):
.env.examplecarried two keys that nothing reads:A2AT_PROMPT_COMPLIANCE_GUARDRAIL_PROVIDER(no such key in the engine or the A2A-T SDK) andA2A_SSL_VERIFY(LoadPsop takessslVerifyas a method parameter).ExecuteResultbuilt viaaddTextPart— neither exists in the A2A Java SDK. The example now shows the realvoid execute(RequestContext, AgentEmitter)contract withupdateStatus/addArtifact.AGENT_STATUS_UPDATE/AGENT_REQUEST/AGENT_RESPONSE, which the engine never emits; replaced with the actually-emittedTASK_*set, including the previously missingNEGOTIATION_FAILED,ROUTE_DECISION, andWORKFLOW_COMPLETE.Everything else the audit checked (remaining 20 env keys, ControlPoint callback signatures, WorkflowEngineClient interface, config builder methods, accessor styles, template URIs, NegotiationRequest fields) is verified aligned.
Test plan