Repository navigation
docs: add software module view to the design guide - #44
Merged
Merged
Conversation
Expand the chapter-3 layer diagram into a module view covering Maven modules, package responsibilities, and dependency boundaries: host callbacks, the zero-A2A-T scheduling kernel guarded by the architecture test, the client adaptation layer as the only a2a-t-core reference site, the optional starter server assembly, and external SDKs and systems. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
Drop the starter from the module view per review: the diagram now highlights the engine's relationships top-down - host agent (starts the engine and implements the callbacks), the scheduling kernel and protocol adaptation inside the engine, the two SDK layers (a2a-java-sdk transports, a2a-t-sdk types), and the external systems: orchestration center, registry center, and dispatched agents (OMC) with the four A2A-T interaction types. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
The edge label 'late-result interception' mixed a relationship with an implementation guard. The edge now states only 'task dispatch'; the guarantee is stated precisely in prose: a result completing after the callback budget expires or the run is cancelled is ignored and never sent. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
The transport base now detects the standard A2A error envelope, so the module view gains that responsibility on the transport node, the key properties state the pre-creation / post-creation failure split (stable a2a.<reason> error codes versus HTTP 200 with TASK_STATE_FAILED), and the design-decisions summary records the same distinction. Chinese and English versions updated symmetrically. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
Zhoujie628
added a commit
to Zhoujie628/workflow-engine-sdk-java
that referenced
this pull request
Sep 4, 2026
Bring over the software module view and its refinements from PR project-openan#44, including the standard-error-contract alignment, and resolve the chapter-2 surrounding-systems diagram drift that predates the module view. Chinese and English versions are now byte-identical to main. Signed-off-by: Zhoujie628 <zhoujie628@users.noreply.github.com>
Zhoujie628
added a commit
to Zhoujie628/workflow-engine-sdk-java
that referenced
this pull request
Sep 4, 2026
Bring dev up to the merged main baseline (error-envelope PR project-openan#46 and the module-view docs PR project-openan#44) while preserving the Eastcom Order overlay. Resolution policy: workflow-engine and spring-boot-starter take main verbatim; samples and root files keep main's newer common content plus dev's Eastcom additions (gateway runtime factory, order transport mode, mock gateway, Eastcom CI gate and docs); parallel-evolved tests take main's canonical versions. 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.
Closes #43
Summary
Adds a software module view to chapter 3 of the design guide (Chinese and English, aligned), directly after the existing four-layer diagram. The view covers:
Verification
Documentation only; mermaid renders and all stated boundaries match the architecture tests and package imports.