docs: polish start guides and align README with start guide#6812
Merged
chenjiahan merged 3 commits intomainfrom Dec 21, 2025
Merged
docs: polish start guides and align README with start guide#6812chenjiahan merged 3 commits intomainfrom
chenjiahan merged 3 commits intomainfrom
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR polishes the English prose in the documentation for improved clarity and consistency. It aligns terminology and wording between the README and the website start guide documentation, making the documentation more natural and professional.
- Improved English phrasing in start guide, CLI guide, and glossary documentation
- Aligned README.md terminology with the start guide (e.g., "performance-focused", "rich set of build features", "framework agnostic")
- Standardized capitalization of feature list items and improved clarity of CLI option descriptions
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/start/quick-start.mdx | Refined instructional language for clarity (e.g., "Use one of the following" → "set up a runtime", "via" instead of "through") |
| website/docs/en/guide/start/index.mdx | Updated key terminology to match README (e.g., "Performance oriented" → "Performance-focused", "Plugin Ecosystem" → "Plugin ecosystem") |
| website/docs/en/guide/start/glossary.mdx | Improved definition clarity and consistency (e.g., simplified "Refers to" → direct definitions) |
| website/docs/en/guide/basic/cli.mdx | Enhanced CLI option descriptions for clarity (e.g., "function content" → "function bodies", improved preposition usage) |
| README.md | Aligned with start guide terminology and capitalization (matching feature names, descriptions, and phrasing from website docs) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chenjiahan
commented
Dec 21, 2025
chenjiahan
commented
Dec 21, 2025
chenjiahan
commented
Dec 21, 2025
chenjiahan
commented
Dec 21, 2025
Merged
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
website/docs/enwhile preserving original meaning.README.Description
website/docs/en/guide/start/index.mdx,website/docs/en/guide/start/quick-start.mdx,website/docs/en/guide/start/glossary.mdx, andwebsite/docs/en/guide/basic/cli.mdxfor clarity and consistency.README.mdto align phrasing and terminology with the start guide (matching headings, bullets, and feature descriptions).performance-focused,rich set of build features, andframework agnosticand corrected small grammar/formatting in CLI options and tips.Testing
pnpm lint, which executed repository linters and returned no errors or warnings.prettier) ran during commit and completed successfully.Codex Task