Repository navigation
Chore/update readme - #297
Merged
Merged
Conversation
cheyang
self-requested a review
April 24, 2026 07:17
There was a problem hiding this comment.
Code Review
This pull request significantly updates the English and Chinese README files, transitioning from a text-heavy format to a more structured layout using tables, badges, and comprehensive code examples. The updates include new sections for project highlights, core concepts (SCOPE), deployment patterns, and detailed inference examples for SGLang and NVIDIA Dynamo. Two typos were identified in the example directory paths within both README files.
- Add new RBG architecture diagram (doc/rbg-structure.png) - Add Deployment Patterns section (standalonePattern/leaderWorkerPattern) - Add RoleTemplates section for reusable pod templates - Add Inference Examples: SGLang PD-disagg and NVIDIA Dynamo runtime - Update Examples Directory structure with latest paths - Add emoji icons to section headers for better readability Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Syspretor
force-pushed
the
chore/update-readme
branch
from
April 24, 2026 07:32
5a8ed4c to
6fd9462
Compare
- Rename `role-temlate` to `role-template` in examples/basic/rbg/ - Update README.md and README-zh_CN.md to reference correct path Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
Ⅰ. Motivation
Ⅱ. Modifications
Ⅲ. Does this pull request fix one issue?
fixes #XXXX
Ⅳ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
Ⅴ. Describe how to verify it
VI. Special notes for reviews
Checklist
make fmt.