Skip to content

Refactor bilingual README for clarity and replace Mermaid diagrams with Excalidraw-based PNG images#29

Merged
nevstop merged 7 commits intoDev_2026Q2from
copilot/update-readme-flow
Apr 21, 2026
Merged

Refactor bilingual README for clarity and replace Mermaid diagrams with Excalidraw-based PNG images#29
nevstop merged 7 commits intoDev_2026Q2from
copilot/update-readme-flow

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 21, 2026

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)

    • Reorganized both README.md and README(zh-cn).md into the same section sequence and intent.
    • Tightened wording in overview, protocol, command sets, and usage to reduce redundancy and improve scanability.
  • Mermaid-to-image migration (feedback update)

    • Removed Mermaid blocks from both READMEs.
    • Switched to static PNG diagrams for:
      • framework architecture
      • command sets
      • client interaction flow
    • Added corresponding editable Excalidraw source files under .doc/*.excalidraw.
    • Renamed diagram assets to descriptive filenames and updated README references accordingly.
  • Terminology, consistency, and accessibility

    • Kept CN/EN structure and semantics aligned.
    • Normalized diagram naming conventions across both READMEs.
    • Improved image alt text descriptions in both languages.

Example diagram used in README:
CSM-TCP-Router framework architecture diagram from remote TCP clients to local CSM modules via router and CSM bus

Copy link
Copy Markdown
Contributor

@nevstop nevstop left a comment

Choose a reason for hiding this comment

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

对mermaid 图不满意,不要再使用这些已经生成的图,我希望生成和原图一样的 excalidraw 版本的图片,然后导出为 png 替换当前的图片

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md and README(zh-cn).md to 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.

Copilot AI and others added 6 commits April 21, 2026 14:30
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 21, 2026

对mermaid 图不满意,不要再使用这些已经生成的图,我希望生成和原图一样的 excalidraw 版本的图片,然后导出为 png 替换当前的图片

已按要求移除 Mermaid,并改为 PNG 图片;同时补充了对应的 Excalidraw 源文件(.doc/*.excalidraw),README 中已切换到新的图片资源。对应提交:1403a85

截图:
framework

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
Copilot AI requested a review from nevstop April 21, 2026 14:42
@nevstop nevstop changed the base branch from main to Dev_2026Q2 April 21, 2026 14:49
@nevstop nevstop marked this pull request as ready for review April 21, 2026 14:50
@nevstop nevstop merged commit 6c31ec9 into Dev_2026Q2 Apr 21, 2026
@nevstop nevstop deleted the copilot/update-readme-flow branch April 21, 2026 14:50
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.

3 participants