Skip to content

Chore/update readme - #297

Merged
cheyang merged 2 commits into
sgl-project:mainfrom
Syspretor:chore/update-readme
Apr 24, 2026
Merged

cheyang merged 2 commits into
sgl-project:mainfrom
Syspretor:chore/update-readme

Conversation

@Syspretor

Copy link
Copy Markdown
Collaborator

Ⅰ. 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

  • Format your code make fmt.
  • Add unit tests or integration tests.
  • Update the documentation related to the change.

@cheyang cheyang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@cheyang
cheyang self-requested a review April 24, 2026 07:17

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread README-zh_CN.md Outdated
- 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
Syspretor force-pushed the chore/update-readme branch from 5a8ed4c to 6fd9462 Compare April 24, 2026 07:32
- 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>

@cheyang cheyang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@cheyang
cheyang merged commit 11320f4 into sgl-project:main Apr 24, 2026
9 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.

2 participants