-
-
Notifications
You must be signed in to change notification settings - Fork 237
docs: improve clarity in documentation files #6532
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
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>
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
This PR improves the clarity and conciseness of English documentation across multiple guide files. The changes focus on making instructions more direct and removing unnecessary words.
- Replaces verbose phrases like "In addition to" with more concise alternatives like "Beyond"
- Removes unnecessary qualifiers such as "you need to", "also", and "currently"
- Streamlines instructions by using imperative voice instead of "you can" constructions
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/optimization/code-splitting.mdx | Simplified language around custom splitting strategies and dynamic imports |
| website/docs/en/guide/framework/react.mdx | Made React plugin and React Compiler setup instructions more concise |
| website/docs/en/guide/faq/exceptions.mdx | Streamlined troubleshooting instructions for common build errors |
| website/docs/en/guide/basic/server.mdx | Clarified dev server configuration and middleware integration instructions |
| website/docs/en/guide/advanced/hmr.mdx | Made HMR configuration and file watching documentation more direct |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Summary
Improved English readability in documentation by removing awkward translation artifacts and verbose phrasing. Changes preserve technical meaning while making text more natural for professional documentation.
Key improvements
Files modified
guide/faq/exceptions.mdx- Exception handling and troubleshootingguide/optimization/code-splitting.mdx- Code splitting strategiesguide/basic/server.mdx- Dev server configurationguide/advanced/hmr.mdx- Hot module replacementguide/framework/react.mdx- React integrationRelated Links
N/A
Checklist
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
iojs.orgcurl --fail --compressed -q -L -s REDACTED -o -(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.