Replace Mermaid diagrams with images to enhance documentation quality#13
Open
lanshi17 wants to merge 3 commits into
Open
Replace Mermaid diagrams with images to enhance documentation quality#13lanshi17 wants to merge 3 commits into
lanshi17 wants to merge 3 commits into
Conversation
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.
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:
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]第一部分-基础篇/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:
en/Part-1-Foundations/03-The-Tool-System-Agent-Hands.md) to use static images instead of Mermaid. [1] [2]第一部分-基础篇/03-工具系统-Agent的双手.md). [1] [2]These changes ensure consistent, reliable display of diagrams across platforms and improve the accessibility and maintainability of the documentation.