Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 7, 2025

Rewrites awkward translations to natural English across 5 documentation files in website/docs/en, preserving technical accuracy and meaning.

Changes

  • Verb forms: Changed inconsistent tenses to active voice ("Preserves" vs "Retain", "is running" vs "runs")
  • Direct instructions: Removed repetitive "you can/need/will" constructions in favor of imperative forms
  • Word precision: Replaced vague terms with specific alternatives ("custom" vs "any", "needs" vs "wants to support", "negatively impacts" vs "is not conducive to")
  • Flow improvements: Removed unnecessary temporal markers ("Now") and simplified conditional statements

Files modified

  • guide/advanced/hmr.mdx - HMR functionality description
  • guide/basic/server.mdx - Dev server usage instructions
  • guide/advanced/environments.mdx - Multi-environment builds
  • guide/advanced/ssr.mdx - Server-side rendering intro
  • guide/basic/static-deploy.mdx - Deployment instructions

Example change:

- If you need to reuse existing middleware in Rsbuild, you can integrate...
+ To reuse existing middleware in Rsbuild, integrate...

30 lines changed across 5 files. Chinese documentation verified as not requiring similar updates.

Original prompt

Improve the English docs in website/docs/en. Many paragraphs were
translated from Chinese and may sound unnatural.

  Rewrite sentences that don't read like authentic, professional English —
  **without changing their meaning** — so they match the tone of
  high-quality open-source docs.


  - **IMPORTANT:** Only change a sentence if it clearly improves clarity or
  correctness.

  - **IMPORTANT:** Don't alter the original meaning.

  - If you edit files in `docs/en`, check the same files in `docs/zh` to see
  if similar updates are needed.

  - Use clear, simple language for non-native English readers.

  - Keep reasonable technical abbreviations (e.g., `dev server`).

  - Use sentence case for Markdown headings.

  - Don't change more than 5 files in one PR.

  - Start PR titles with `docs:`.

💡 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.

@netlify
Copy link

netlify bot commented Nov 7, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 729ac91
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/690d39ca4e23840008240b10
😎 Deploy Preview https://deploy-preview-6523--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 70 (🔴 down 10 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Copilot AI changed the title [WIP] Docs: Improve clarity and correctness of English documentation docs: improve English clarity in documentation Nov 7, 2025
Copilot AI requested a review from chenjiahan November 7, 2025 00:17
Copilot finished work on behalf of chenjiahan November 7, 2025 00:17
@chenjiahan chenjiahan marked this pull request as ready for review November 7, 2025 08:09
Copilot AI review requested due to automatic review settings November 7, 2025 08:09
@chenjiahan chenjiahan merged commit 3e51382 into main Nov 7, 2025
22 of 23 checks passed
@chenjiahan chenjiahan deleted the copilot/improve-docs-english-quality branch November 7, 2025 08:09
Copy link
Contributor

Copilot AI left a 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.
Copy link

Copilot AI Nov 7, 2025

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.

Suggested change
- 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.

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Nov 7, 2025

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
@chenjiahan chenjiahan mentioned this pull request Nov 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants