docs: improve English clarity in documentation files#6377
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 English clarity and naturalness in documentation files by fixing awkward phrasing that indicated direct translation from Chinese. The changes make the documentation more idiomatic and professional for English readers while preserving all original meanings.
- Replaced unnatural constructions with more fluent English phrasing
- Improved consistency in verb tenses and terminology usage
- Enhanced technical accuracy with proper compiler terminology
Reviewed Changes
Copilot reviewed 9 out of 9 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 | Improved phrasing in quick start guide and standardized tool name capitalization |
| website/docs/en/guide/start/index.mdx | Enhanced introduction with more natural English and consistent verb tenses |
| website/docs/en/guide/optimization/build-performance.mdx | Clarified optimization language and improved readability |
| website/docs/en/guide/faq/general.mdx | Simplified phrasing and removed unnecessary articles |
| website/docs/en/guide/basic/static-assets.mdx | Minor wording improvements for clarity |
| website/docs/en/guide/basic/server.mdx | Enhanced clarity in server documentation |
| website/docs/en/guide/basic/html-template.mdx | Improved template engine description |
| website/docs/en/guide/advanced/hmr.mdx | Standardized product name capitalization |
| website/docs/en/guide/advanced/env-vars.mdx | Fixed technical terminology and removed duplicate words |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ## Default variables | ||
|
|
||
| By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their specified values during the build: | ||
| By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their values during during the build: |
There was a problem hiding this comment.
Duplicate word 'during' should be removed.
| By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their values during during the build: | |
| By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their values during the build: |

Overview
This PR improves the English clarity and naturalness in 9 documentation files under
website/docs/en/guide/. Many paragraphs were translated from Chinese and contained phrasing that didn't sound like authentic, professional English. All changes are minor wording improvements that make the text more idiomatic without altering the original meaning.Motivation
The documentation contained several patterns that indicated direct translation:
These patterns made the documentation less accessible and professional, particularly for native English speakers.
Changes Made
Files Updated (9 total)
Getting Started:
start/index.mdx- Introduction pagestart/quick-start.mdx- Quick start guideBasic Guides:
basic/server.mdx- Dev server documentationbasic/html-template.mdx- HTML templates guidebasic/static-assets.mdx- Static assets guideAdvanced Guides:
advanced/env-vars.mdx- Environment variables guideadvanced/hmr.mdx- Hot module replacement guideOptimization & FAQ:
optimization/build-performance.mdx- Build performance optimizationfaq/general.mdx- General FAQKey Improvements
More natural phrasing:
Better consistency:
Technical accuracy:
Clearer language:
Testing
Notes
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.