Skip to content

docs:add simple system architecture part for README-EN.md & README.md#212

Closed
ChinmayShringi wants to merge 1 commit intomainfrom
docs/add-sys-architecture-part
Closed

docs:add simple system architecture part for README-EN.md & README.md#212
ChinmayShringi wants to merge 1 commit intomainfrom
docs/add-sys-architecture-part

Conversation

@ChinmayShringi
Copy link
Owner

PR Title

docs(readme): simplify system architecture section to Layer Breakdown + Project Code Structure Tree only

Summary

This PR simplifies the System Architecture section in both Chinese and English README files by keeping only two high-signal sections:

  • Layer Breakdown
  • Project Code Structure Tree

The previously added overall architecture diagram and related agent-intro block were removed to keep the documentation focused and maintainable.

Changes

Kept

  • Layered architecture table (responsibility-oriented)
  • File-level project structure tree (code-oriented)

Removed

  • Overall architecture image module
  • Associated architecture-intro text block

Why

  • Reduce visual/maintenance overhead in README
  • Keep architecture docs concise and implementation-aligned
  • Improve readability for contributors who want quick codebase orientation

Impact

  • Documentation-only change
  • No runtime or API behavior changes

Validation

  • Verified both README files render correctly
  • Confirmed section structure is consistent in CN/EN docs

Original PR: 666ghj/MiroFish#132
Original Author: @Noblegasesgoo

@ChinmayShringi ChinmayShringi added the documentation Improvements or additions to documentation label Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant