-
- Notifications
You must be signed in to change notification settings - Fork 234
docs: improve documentation authenticity and clarity #6302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: improve documentation authenticity and clarity #6302
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Improve the authenticity and clarity of English documentation across Rsbuild guides and config docs by refining phrasing while preserving technical meaning.
- Standardize terminology and simplify sentences for readability
- Clarify configuration descriptions and tips without altering behavior
- Maintain consistency in references and links across docs
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/styling/css-modules.mdx | Refines explanations and instructions for CSS Modules usage and type generation. |
| website/docs/en/guide/optimization/inline-assets.mdx | Clarifies inlining behaviors, configuration, and TypeScript declarations; improves tip language. |
| website/docs/en/guide/optimization/code-splitting.mdx | Polishes strategy descriptions, notes, and customization guidance. |
| website/docs/en/guide/optimization/build-performance.mdx | Tightens language around profiling, caching, tooling, and dev-mode optimizations. |
| website/docs/en/guide/basic/static-assets.mdx | Improves definition and explanation of static assets. |
| website/docs/en/guide/basic/server.mdx | Clarifies base path usage and routing behavior. |
| website/docs/en/guide/basic/output-files.mdx | Refines descriptions of output structure and dev-mode behavior. |
| website/docs/en/guide/basic/cli.mdx | Streamlines CLI usage explanations and option descriptions. |
| website/docs/en/guide/advanced/env-vars.mdx | Clarifies environment variable injection timing and defaults. |
| website/docs/en/config/server/proxy.mdx | Improves proxy config explanations and wording for options. |
| website/docs/en/config/output/data-uri-limit.mdx | Clarifies thresholds and examples for inlining assets. |
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 the
website/docs/endirectory by replacing non-authentic phrasing with more natural, idiomatic English expressions. The improvements maintain the original technical meaning while making the documentation more professional and easier to read for both native and non-native English speakers.Changes Made
Improved 12 documentation files across various sections:
Guide Documentation
Configuration Documentation
Examples of Improvements
Before: "Rsbuild optimizes build performance by default, but as projects become larger, you may encounter build performance issues."
After: "Rsbuild optimizes build performance by default, but you may encounter performance issues as your project grows larger."
Before: "If you do not want
/apito be passed along, we need to rewrite the path:"After: "If you don't want
/apito be passed along, we need to rewrite the path:"Before: "Although the above method can provide the type of CSS Modules, it cannot accurately prompt which classNames are exported by a certain CSS file."
After: "The above method provides types for CSS Modules, but cannot accurately indicate which class names are exported by a specific CSS file."
Principles Applied
Impact
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.