docs(plan-mode): correct Mermaid syntax in English plan mode guide - #2734
Open
Alanyaeer wants to merge 4 commits into
Open
docs(plan-mode): correct Mermaid syntax in English plan mode guide#2734Alanyaeer wants to merge 4 commits into
Alanyaeer wants to merge 4 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
AgentScopeJavaBot
approved these changes
Aug 17, 2026
AgentScopeJavaBot
left a comment
Collaborator
There was a problem hiding this comment.
🤖 AI Review
This PR corrects Mermaid syntax issues in the English plan-mode guide document. The changes include replacing unsupported note directives with inline classDef styling, converting rect blocks to subgraph syntax, and adding a YAML front-matter block to exclude the document from DevSite search indexing. The Mermaid diagram now renders correctly on MkDocs. The changes are focused, well-scoped, and achieve their stated goal.
(inline comments could not be attached — line numbers fell outside PR hunks. See archived report.)
Author
|
@larry-zy hi larry can you review this pr |
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
Fix the Mermaid syntax error in the Workflow diagram on the English Plan Mode documentation page.
Root Cause
Mermaid treats a semicolon in a sequence-diagram message as a statement separator. In the original message:
A->>A: enter execution phase; all tools allowed
all tools allowed is parsed as an invalid standalone statement, causing the diagram to fail to render.
The current English Plan Mode page renders the Workflow diagram as follows:

https://java.agentscope.io/v2/en/docs/harness/plan-mode.html
Changes
Replace the semicolon with a colon so the text is parsed as one valid message:
A->>A: enter execution phase: all tools allowed
Verification
Reference: https://mermaid.js.org/syntax/sequenceDiagram.html