docs: improve English clarity and natural flow in documentation#6382
docs: improve English clarity and natural flow in documentation#6382chenjiahan merged 11 commits intomainfrom
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR improves the clarity and natural flow of English documentation across 8 files to make them read more authentically. The changes focus on replacing verbose or unnatural phrasing with concise, professional English while preserving all technical content and meaning.
- Replaced passive voice with active voice where appropriate ("can be accessed" → "you can access")
- Simplified verbose constructions for better readability
- Streamlined conditional statements ("If you want to skip" → "To skip")
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| guide/start/quick-start.mdx | Enhanced setup instructions and template descriptions |
| guide/framework/react.mdx | Improved React Compiler and hot reload explanations |
| guide/configuration/rsbuild.mdx | Clarified config file loading and export function descriptions |
| guide/basic/static-assets.mdx | Enhanced static asset handling explanations |
| guide/basic/server.mdx | Improved dev server functionality descriptions |
| guide/basic/output-files.mdx | Refined asset handling descriptions |
| guide/advanced/browserslist.mdx | Enhanced browser configuration examples and explanations |
| guide/advanced/browser-compatibility.mdx | Improved polyfill and transpilation explanations |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Overview
This PR improves the English documentation in 8 files to make them read more naturally and professionally. Many paragraphs were originally translated from Chinese and contained phrasing that, while technically correct, didn't sound like authentic English.
What Changed
Improved documentation in the following files:
guide/basic/server.mdx- Dev server functionality and middleware integrationguide/framework/react.mdx- React Compiler and hot reload sectionsguide/configuration/rsbuild.mdx- Config file loading and export functionsguide/start/quick-start.mdx- Setup instructionsguide/advanced/browser-compatibility.mdx- Polyfills and transpilation explanationsguide/basic/output-files.mdx- Asset handling descriptionsguide/advanced/browserslist.mdx- Browser configuration examplesguide/basic/static-assets.mdx- Static asset handlingExamples of Improvements
Before:
After:
Before:
After:
Before:
After:
Key Changes
What Didn't Change
Testing
Notes
This PR stays under the 10-file limit as requested. The changes are minimal and surgical, focused only on improving readability while maintaining technical accuracy and consistency with high-quality open-source documentation standards.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.