-
-
Notifications
You must be signed in to change notification settings - Fork 237
docs: improve English clarity in documentation #6523
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 documentation across multiple guide files by streamlining instructional language. The changes make the documentation more direct and action-oriented by removing unnecessary phrases.
- Replaces wordy constructions like "you can/need to/should" with direct imperative instructions
- Simplifies sentence structures for better readability
- Maintains the same technical meaning while improving flow
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/basic/static-deploy.mdx | Streamlines deployment instructions by using direct imperatives instead of "you need to/can" constructions |
| website/docs/en/guide/basic/server.mdx | Simplifies server configuration and routing documentation with more concise phrasing |
| website/docs/en/guide/advanced/ssr.mdx | Improves SSR documentation clarity with direct language and better sentence flow |
| website/docs/en/guide/advanced/hmr.mdx | Enhances HMR documentation by using active voice and more precise descriptions |
| website/docs/en/guide/advanced/environments.mdx | Clarifies environments documentation with streamlined instructional language |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Instantly update the browser when modifying CSS / JS in source code, almost comparable to changing styles directly in the browser's dev tools. | ||
| - Preserves application state that would be lost during a full reload. | ||
| - Saves valuable development time by updating only what changed. | ||
| - Instantly updates the browser when modifying CSS/JS in source code, similar to changing styles directly in the browser's dev tools. |
Copilot
AI
Nov 7, 2025
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.
[nitpick] The removal of the space in 'CSS / JS' to 'CSS/JS' is inconsistent with the original formatting style. This spacing change should be reverted to maintain consistency with the rest of the documentation, which typically uses spaces around separators for better readability.
| - Instantly updates the browser when modifying CSS/JS in source code, similar to changing styles directly in the browser's dev tools. | |
| - Instantly updates the browser when modifying CSS / JS in source code, similar to changing styles directly in the browser's dev tools. |
| In traditional client-side rendering, the server sends an empty HTML shell and some JavaScript scripts to the client, which then fetches data from the server's API and fills the page with dynamic content. This leads to slow initial page loading times and negatively impacts user experience and SEO. | ||
|
|
||
| With SSR, the server generates HTML that already contains dynamic content and sends it to the client. This makes the initial page loading faster and more SEO-friendly, as search engines can crawl the rendered page. | ||
| With SSR, the server generates HTML that already contains dynamic content and sends it to the client. This makes initial page loading faster and more SEO-friendly, as search engines can crawl the rendered page. |
Copilot
AI
Nov 7, 2025
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.
[nitpick] The removal of 'the' before 'initial page loading' changes the sentence to use a noun phrase instead of a definite article. While grammatically acceptable, 'the initial page loading' is more natural in this context and should be retained for consistency with standard English usage.
| With SSR, the server generates HTML that already contains dynamic content and sends it to the client. This makes initial page loading faster and more SEO-friendly, as search engines can crawl the rendered page. | |
| With SSR, the server generates HTML that already contains dynamic content and sends it to the client. This makes the initial page loading faster and more SEO-friendly, as search engines can crawl the rendered page. |

Rewrites awkward translations to natural English across 5 documentation files in
website/docs/en, preserving technical accuracy and meaning.Changes
Files modified
guide/advanced/hmr.mdx- HMR functionality descriptionguide/basic/server.mdx- Dev server usage instructionsguide/advanced/environments.mdx- Multi-environment buildsguide/advanced/ssr.mdx- Server-side rendering introguide/basic/static-deploy.mdx- Deployment instructionsExample change:
30 lines changed across 5 files. Chinese documentation verified as not requiring similar updates.
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.