Skip to content

docs: make the README concise - #35

Merged
yanpgwang merged 2 commits into
mainfrom
codex/concise-readme
Jul 30, 2026
Merged

docs: make the README concise#35
yanpgwang merged 2 commits into
mainfrom
codex/concise-readme

Conversation

@yanpgwang

Copy link
Copy Markdown
Owner

Summary

  • remove the repeated text title, subtitle, and badge row from the hero
  • keep one direct positioning line under the Mango logo
  • reduce the README from 308 lines / 1,563 words to 114 lines / 489 words
  • retain the quick start, core differentiators, architecture, current scope, and key documentation links
  • move detailed runtime configuration, production gaps, and failure semantics to the existing docs

Validation

  • git diff --check origin/main...HEAD
  • GitHub GFM rendering via the Markdown API
  • verified all 13 local README links resolve

@yanpgwang
yanpgwang merged commit 6c27a7a into main Jul 30, 2026
4 checks passed
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