Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 8, 2025

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

  • Direct instructions: "you need to register" → "register"
  • Natural transitions: "In addition to" → "Beyond", "Through X" → "Using X"
  • Simplified conditionals: "it is usually caused by" → "it's usually caused by"
  • Concise phrasing: "If you encounter this error during the compilation process, it means that..." → "This error means..."

Files modified

  • guide/faq/exceptions.mdx - Exception handling and troubleshooting
  • guide/optimization/code-splitting.mdx - Code splitting strategies
  • guide/basic/server.mdx - Dev server configuration
  • guide/advanced/hmr.mdx - Hot module replacement
  • guide/framework/react.mdx - React integration

Related Links

N/A

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

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.org
    • Triggering command: curl --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

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:`.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@netlify
Copy link

netlify bot commented Nov 8, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit aa1a3e9
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/690f3472992bd00008d2030b
😎 Deploy Preview https://deploy-preview-6532--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: 67 (🟢 up 2 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

CLAassistant commented Nov 8, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ chenjiahan
❌ Copilot
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 in English documentation docs: improve English clarity in 5 documentation files Nov 8, 2025
Copilot AI requested a review from chenjiahan November 8, 2025 03:26
Copilot finished work on behalf of chenjiahan November 8, 2025 03:26
@chenjiahan chenjiahan changed the title docs: improve English clarity in 5 documentation files docs: improve clarity in documentation files Nov 8, 2025
@chenjiahan chenjiahan marked this pull request as ready for review November 8, 2025 12:16
Copilot AI review requested due to automatic review settings November 8, 2025 12:16
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 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.

@chenjiahan chenjiahan merged commit 0cf8409 into main Nov 8, 2025
16 of 17 checks passed
@chenjiahan chenjiahan deleted the copilot/improve-english-docs branch November 8, 2025 23:26
@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