docs: redesign README with modern layout #629
Merged
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
Rewrite both README.md and README_zh_cn.md with a Fumadocs-inspired design: hero with social proof stats, 3x2 HTML table feature cards, before/after comparison, streamlined packages table, and merged related projects section. Removes legacy branches, showcase grid, and verbose sections in favor of scannable progressive disclosure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
github-actions
bot
added
the
documentation
There was a problem hiding this comment.
Pull request overview
Redesigns the English and Chinese READMEs with a modern, “hero + feature grid + quick start” layout to present JEngine’s value proposition more clearly and compactly.
Changes:
- Added hero/tagline sections and streamlined top navigation links.
- Replaced long feature lists with a 3×2 feature-card grid (HTML table) and added a “Before & After” comparison table.
- Simplified Packages + dependencies presentation and consolidated related projects/community sections.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | New hero + HTML feature grid + “Before & After”, simplified packages/deps and community/related projects sections. |
| README_zh_cn.md | Chinese equivalent of the new structure: hero + HTML feature grid + comparison, simplified packages/deps and community/related projects. |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Owner
Author
|
Re: HTML table + Markdown rendering concern (EN README) — GitHub does parse Markdown inside |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Move lightweight emphasis from Quick Start into a dedicated feature card. Merge Zero Allocation into the 10x+ Performance card. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
README.mdandREADME_zh_cn.mdwith a clean, Fumadocs-inspired layout🎉 Latest Features/📋 View Complete Changelog) preserved and verifiedTest plan
<details>is not present / legacy branches removedgrep -c "🎉 Latest Features" README.md= 1grep -c "🎉 最新功能" README_zh_cn.md= 1🤖 Generated with Claude Code