Skip to content

Replace Mermaid diagrams with images to enhance documentation quality#13

Open
lanshi17 wants to merge 3 commits into
lintsinghua:mainfrom
lanshi17:main
Open

Replace Mermaid diagrams with images to enhance documentation quality#13
lanshi17 wants to merge 3 commits into
lintsinghua:mainfrom
lanshi17:main

Conversation

@lanshi17
Copy link
Copy Markdown
Contributor

@lanshi17 lanshi17 commented Apr 7, 2026

This pull request updates both the English and Chinese documentation to replace all embedded Mermaid diagrams with static image files for improved rendering and portability. The diagrams illustrating core concepts in the dialog loop, message types, tool system, and state machines are now referenced as local image assets, with descriptive alt text provided for accessibility.

Documentation Diagram Updates:

Dialog Loop and State Machine Visualizations:

  • Replaced Mermaid diagrams with image references in the English documentation (en/Part-1-Foundations/02-The-Dialog-Loop-Heartbeat-of-an-Agent.md), including diagrams for async generators, message types, dialog loop flow, termination reasons, and state transitions. [1] [2] [3] [4] [5]
  • Made corresponding replacements in the Chinese documentation (第一部分-基础篇/02-对话循环-Agent的心跳.md), ensuring all Mermaid diagrams are replaced with appropriate image files and localized alt text. [1] [2] [3] [4] [5]

Tool System and Execution Flow:

  • Updated tool batching and execution timeline diagrams in the English tool system documentation (en/Part-1-Foundations/03-The-Tool-System-Agent-Hands.md) to use static images instead of Mermaid. [1] [2]
  • Applied the same updates to the Chinese tool system documentation (第一部分-基础篇/03-工具系统-Agent的双手.md). [1] [2]

These changes ensure consistent, reliable display of diagrams across platforms and improve the accessibility and maintainability of the documentation.

lanshi17 and others added 3 commits April 6, 2026 17:21
docs(fundamentals): 添加基础概念图表资源并替换Mermaid代码块

- 新增5个图表资源文件:异步生成器图、消息类型图、对话循环流程图、终止原因分类图、状态转换图
- 将英文文档中的Mermaid代码块替换为对应的PNG图片引用
- 将中文文档中的Mermaid代码块替换为对应的PNG图片引用
- 优化文档渲染效果,提升图表显示质量
```
docs(Tool System): 使用图片替换Mermaid图表以优化文档显示

在工具系统的文档中,将原有的Mermaid流程图和状态图替换为静态图片,
包括并发分区示例和四阶段状态机图。同时更新.gitignore文件以忽略
command.log文件,并添加相关图片资源到项目中。

此更改提高了文档的渲染性能和可读性。
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant