Skip to content

docs(plan-mode): correct Mermaid syntax in English plan mode guide - #2734

Open
Alanyaeer wants to merge 4 commits into
agentscope-ai:mainfrom
Alanyaeer:fix/docs-plan-mode-mermaid
Open

docs(plan-mode): correct Mermaid syntax in English plan mode guide#2734
Alanyaeer wants to merge 4 commits into
agentscope-ai:mainfrom
Alanyaeer:fix/docs-plan-mode-mermaid

Conversation

@Alanyaeer

@Alanyaeer Alanyaeer commented Aug 16, 2026

Copy link
Copy Markdown

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:
image

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

  • Confirmed that the original page displays a Mermaid syntax error.
  • The updated syntax follows Mermaid sequence-diagram message rules.
  • Documentation-only change; no Java source code or runtime behavior is affected.

Reference: https://mermaid.js.org/syntax/sequenceDiagram.html

@CLAassistant

CLAassistant commented Aug 16, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@Alanyaeer Alanyaeer changed the title fix(docs): correct Mermaid syntax in English plan mode guide docs(plan-mode): correct Mermaid syntax in English plan mode guide Aug 16, 2026
@codecov

codecov Bot commented Aug 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AgentScopeJavaBot AgentScopeJavaBot added the area/docs Documentation label Aug 17, 2026

@AgentScopeJavaBot AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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.)

@Alanyaeer

Copy link
Copy Markdown
Author

@larry-zy hi larry can you review this pr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants