Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 29, 2025

Many paragraphs in website/docs/en were 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:

  • Getting started: quick-start.mdx
  • Optimization guides: build-performance.mdx, optimize-bundle.mdx, code-splitting.mdx
  • Basic guides: html-template.mdx, static-assets.mdx, typescript.mdx
  • Advanced guides: env-vars.mdx, browser-compatibility.mdx, hmr.mdx

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

  • Remove unnecessary qualifiers: "just", "step by step", "can", "will"
  • Use contractions naturally: "isn't", "don't", "won't"
  • Prefer active voice over passive
  • Simplify complex constructions
  • Use consistent terminology: "duplicate" not "duplicated"

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

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

@CLAassistant
Copy link

CLAassistant commented Oct 29, 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.

@netlify
Copy link

netlify bot commented Oct 29, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 7fe0a68
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/6902e237cff51c000814e94e
😎 Deploy Preview https://deploy-preview-6460--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 (🔴 down 6 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.

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 documentation clarity and naturalness Oct 29, 2025
Copilot AI requested a review from chenjiahan October 29, 2025 14:43
Copilot finished work on behalf of chenjiahan October 29, 2025 14:43
@chenjiahan chenjiahan changed the title docs: improve English documentation clarity and naturalness docs: improve documentation clarity and naturalness Oct 30, 2025
@chenjiahan chenjiahan marked this pull request as ready for review October 30, 2025 03:58
Copilot AI review requested due to automatic review settings October 30, 2025 03:58
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 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.

@chenjiahan chenjiahan merged commit e8e1ea5 into main Oct 30, 2025
17 of 18 checks passed
@chenjiahan chenjiahan deleted the copilot/improve-english-docs branch October 30, 2025 04:01
@chenjiahan chenjiahan mentioned this pull request Oct 30, 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