Refactor bilingual README for clarity and replace Mermaid diagrams with Excalidraw-based PNG images#29
Merged
nevstop merged 7 commits intoDev_2026Q2from Apr 21, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/457dc57e-fd6d-4087-a604-3a7a4dd68b7b Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
nevstop
April 21, 2026 14:22
View session
nevstop
requested changes
Apr 21, 2026
Contributor
nevstop
left a comment
There was a problem hiding this comment.
对mermaid 图不满意,不要再使用这些已经生成的图,我希望生成和原图一样的 excalidraw 版本的图片,然后导出为 png 替换当前的图片
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the project’s bilingual documentation to be shorter and structurally aligned between English and Chinese, while replacing previously embedded static diagrams/screenshots with equivalent Mermaid diagrams.
Changes:
- Rewrote/reshaped sections in
README.mdandREADME(zh-cn).mdto follow the same flow and reduce redundancy. - Replaced static image embeds with three Mermaid diagrams (architecture, command taxonomy, and client/server interaction) in both READMEs.
- Normalized terminology and command/protocol naming across CN/EN.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | English README rewrite + Mermaid diagrams for architecture/commands/sequence flow. |
| README(zh-cn).md | Chinese README rewrite mirroring the English structure + same Mermaid diagrams localized. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/a92684df-d1ef-4e7f-801e-473ee3d2911d Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/a92684df-d1ef-4e7f-801e-473ee3d2911d Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/a92684df-d1ef-4e7f-801e-473ee3d2911d Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/a92684df-d1ef-4e7f-801e-473ee3d2911d Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/a92684df-d1ef-4e7f-801e-473ee3d2911d Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App/sessions/a92684df-d1ef-4e7f-801e-473ee3d2911d Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Contributor
Author
Copilot
AI
changed the title
Refactor bilingual README for clarity and replace static images with aligned Mermaid diagrams
Refactor bilingual README for clarity and replace Mermaid diagrams with Excalidraw-based PNG images
Apr 21, 2026
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 updates the Chinese and English READMEs to be clearer, shorter, and structurally consistent. Based on feedback, Mermaid diagrams were removed and replaced with PNG images exported from Excalidraw sources, preserving the same architecture, command-set, and interaction content.
Documentation flow rewrite (CN/EN aligned)
README.mdandREADME(zh-cn).mdinto the same section sequence and intent.Mermaid-to-image migration (feedback update)
.doc/*.excalidraw.Terminology, consistency, and accessibility
Example diagram used in README:
