Repository navigation
docs: fix 18 doc-code gaps, convert all diagrams to Mermaid - #21
Merged
Merged
Conversation
Fix documentation-vs-code gaps identified in deep analysis: HIGH: - README: move LlmHelper to samples module (was listed under client) - API_REFERENCE (en+zh): add missing core package section - API_REFERENCE + DEVELOPER_GUIDE (en+zh): add TASK_STATUS_CHANGED and WORKFLOW_COMPLETE EventType constants (code has 22, docs had 20) - CHANGELOG: replace stale ExtensionCallback reference with ExtensionSender - pom.xml: fix SCM URL from personal fork to project-openan upstream MEDIUM: - DESIGN (en+zh): remove duplicate Section 4, fix numbering 7->8->9 - DEVELOPER_GUIDE (en+zh): fix checklist (3 required -> 2 required + 2 defaults) - DEVELOPER_GUIDE (en+zh): fix broken code formatting in AuthProvider section - API_REFERENCE (en+zh): add ConversationScopedA2AJavaClientRuntime - API_REFERENCE (en+zh): add TaskStatus enum (PENDING/RUNNING/SUCCESS/FAILED) - API_REFERENCE (en+zh): add AgentCardJacksonModule and AgentCardNormalizer - API_REFERENCE (en+zh): add spring-boot-starter module documentation - notification-t-design-analysis (en+zh): fix 5 broken Mermaid blocks, fix stale file paths LOW: - README: add missing Chinese doc links - DESIGN: replace asyncio.gather (Python) with CompletableFuture (Java) - README + DESIGN: align architecture layer descriptions (add Foundation layer) Diagrams: - Convert all ASCII art diagrams to Mermaid format across: README.md, docs/zh/DESIGN.md, docs/zh/工作台AgentScope结合方案.md 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.
Summary
Deep analysis of the Java execution engine repository identified 18 gaps between documentation and actual code implementation. This PR fixes all of them and converts every ASCII art diagram to Mermaid.
HIGH Priority Fixes
LlmHelperunderclientpackage — actually insamplesmodulecorepackage (WorkflowExecutor, ContextBuilder) missing from API_REFERENCE and READMETASK_STATUS_CHANGEDandWORKFLOW_COMPLETEExtensionCallbackthat no longer existsExtensionSenderproject-openan/workflow-engine-sdk-javaMEDIUM Priority Fixes
LOW Priority Fixes
asyncio.gather(Python) →CompletableFuture(Java)Mermaid Conversion
All ASCII art diagrams converted to
mermaidformat:Files Changed (12 files, +393/-102)
pom.xml,CHANGELOG.md,README.md,docs/en/{API_REFERENCE,DESIGN,DEVELOPER_GUIDE,notification-t-design-analysis}.md,docs/zh/{API_REFERENCE,DESIGN,DEVELOPER_GUIDE,notification-t-design-analysis,工作台AgentScope结合方案}.mdVerification
mvn compileBUILD SUCCESSmvn test10/10 tests passCloses #20