docs: clarify README features and onboarding flow - #2086
Merged
Merged
Conversation
jwx0925
requested review from
Pangjiping,
hittyt and
ninan-nn
as code owners
September 30, 2026 04:04
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Pangjiping
approved these changes
Sep 30, 2026
Pangjiping
previously approved these changes
Sep 30, 2026
Pangjiping
approved these changes
Sep 30, 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.
Summary
The README makes readers navigate installation details before reaching the first sandbox workflow, and its feature and example lists are difficult to scan. Clarify the opening, add direct navigation, and organize capabilities and use cases into tables.
Testing
git diff --checkcd docs && pnpm docs:build(passed; bundle-size warning only)Breaking Changes
Checklist