-
-
Notifications
You must be signed in to change notification settings - Fork 231
docs: improve documentation clarity and naturalness #6460
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 Rsbuild's English documentation across multiple guide sections. The changes focus on making the documentation more direct and easier to read by simplifying sentence structures and using consistent contractions.
Key changes:
- Simplified verbose phrases (e.g., "give you an intuitive sense of" → "demonstrate")
- Consistently applied contractions (e.g., "does not" → "doesn't", "will not" → "won't")
- Streamlined wordy expressions (e.g., "Follow the prompts step by step" → "Follow the prompts")
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/start/quick-start.mdx | Simplified instructional language and template descriptions |
| website/docs/en/guide/optimization/optimize-bundle.mdx | Improved clarity of optimization explanations and section heading |
| website/docs/en/guide/optimization/code-splitting.mdx | Streamlined code splitting strategy descriptions |
| website/docs/en/guide/optimization/build-performance.mdx | Made performance optimization guidance more concise |
| website/docs/en/guide/basic/typescript.mdx | Simplified TypeScript-related instructions |
| website/docs/en/guide/basic/static-assets.mdx | Improved clarity of static asset handling explanations |
| website/docs/en/guide/basic/html-template.mdx | Streamlined HTML template usage descriptions |
| website/docs/en/guide/advanced/hmr.mdx | Made HMR documentation more direct |
| website/docs/en/guide/advanced/env-vars.mdx | Simplified environment variable explanations |
| website/docs/en/guide/advanced/browser-compatibility.mdx | Improved clarity of browser compatibility concepts |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Many paragraphs in
website/docs/enwere translated from Chinese and read unnaturally. This PR rewrites sentences to match the tone of high-quality open-source documentation without changing their meaning.Changes
Improved 10 core documentation files:
Examples
Before: "These examples give you an intuitive sense of Rspack's build performance"
After: "These examples demonstrate Rspack's build performance"
Before: "you can try enabling parallel compilation to improve build performance"
After: "enable parallel compilation to improve build performance"
Before: "Rsbuild provides a configuration that can significantly improve rebuild speed"
After: "Rsbuild provides a configuration that significantly improves rebuild speed"
Pattern fixes
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 -q --fail --compressed -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
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.