[Docs] refresh README structure and links#46
Merged
yubofredwang merged 3 commits intomainfrom Mar 19, 2026
Merged
Conversation
Reorganize the README into a clearer project overview so setup, examples, and operational guidance are easier to scan. Surface the release blog, released draft model, and MiniMax support near the top to better reflect the current project state.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 48f2822d35
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Align the README opening with the preferred project description and link Mooncake where it is first mentioned. Keep the rest of the README refresh unchanged.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes README.md to present a clearer project overview with a TOC, a Quick Start section, and more prominent links reflecting the project’s current status (blog + released draft model).
Changes:
- Rewrites the introduction and adds a “Blogs” section near the top.
- Adds a Table of Contents and a new “Architecture Overview” narrative.
- Reorders/rewrites Setup/Examples/Training/Conversion/Troubleshooting sections for scanability.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Point the README examples table at the new 5-node MiniMax folder so the documented path matches the current example layout.
zhubohao911
pushed a commit
to zhubohao911/TorchSpec
that referenced
this pull request
Mar 23, 2026
zhubohao911
pushed a commit
to zhubohao911/TorchSpec
that referenced
this pull request
Mar 23, 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.
Reorganize the README into a clearer project overview so setup, examples, and operational guidance are easier to scan. Surface the release blog, released draft model, and MiniMax support near the top to better reflect the current project state.