Skip to content

docs: improve English clarity in documentation files#6377

Merged
chenjiahan merged 6 commits intomainfrom
copilot/improve-english-docs
Oct 18, 2025
Merged

docs: improve English clarity in documentation files#6377
chenjiahan merged 6 commits intomainfrom
copilot/improve-english-docs

Conversation

Copy link
Contributor

Copilot AI commented Oct 18, 2025

Overview

This PR improves the English clarity and naturalness in 9 documentation files under website/docs/en/guide/. Many paragraphs were translated from Chinese and contained phrasing that didn't sound like authentic, professional English. All changes are minor wording improvements that make the text more idiomatic without altering the original meaning.

Motivation

The documentation contained several patterns that indicated direct translation:

  • Awkward verb tenses ("switched" vs "has switched")
  • Unnatural constructions ("focuses strongly" vs "places a strong focus")
  • Non-idiomatic phrases ("give you an intuitive feel for" vs "give you an intuitive sense of")
  • Inconsistent terminology (mixed capitalization of tool names)

These patterns made the documentation less accessible and professional, particularly for native English speakers.

Changes Made

Files Updated (9 total)

Getting Started:

  • start/index.mdx - Introduction page
  • start/quick-start.mdx - Quick start guide

Basic Guides:

  • basic/server.mdx - Dev server documentation
  • basic/html-template.mdx - HTML templates guide
  • basic/static-assets.mdx - Static assets guide

Advanced Guides:

  • advanced/env-vars.mdx - Environment variables guide
  • advanced/hmr.mdx - Hot module replacement guide

Optimization & FAQ:

  • optimization/build-performance.mdx - Build performance optimization
  • faq/general.mdx - General FAQ

Key Improvements

More natural phrasing:

  • "thoughtfully designed" → "carefully designed"
  • "that fully unleashes" → "while fully leveraging"
  • "pursues lightweight and flexibility" → "focuses on being lightweight and flexible"

Better consistency:

  • Unified verb tenses for similar actions
  • Consistent tool name capitalization (Prettier, ESLint, Biome)
  • Standardized phrasing across sections

Technical accuracy:

  • "invalid code" → "dead code" (proper compiler terminology)
  • "during the build" → "during compilation" (more precise)
  • "React Refresh" instead of "react-refresh" (proper case)

Clearer language:

  • "optimization methods" → "optimization strategies"
  • "which is a library development tool" → "a library development tool"
  • "runs on localhost:5173" → "runs on http://localhost:5173"

Testing

  • ✅ All changes pass Prettier formatting checks
  • ✅ No breaking changes to code or functionality
  • ✅ Preserved all technical terms and product names
  • ✅ Maintained simple language suitable for non-native English readers

Notes

  • Total changes: 26 lines modified across 9 files
  • All changes preserve the original meaning
  • No functional changes, only documentation improvements
  • Follows project guidelines: max 10 files per PR, "docs:" prefix in title
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:`.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@netlify
Copy link

netlify bot commented Oct 18, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 86e4b8c
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68f362c6677a060008794b43
😎 Deploy Preview https://deploy-preview-6377--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 3 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 Oct 18, 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.

Copilot AI and others added 3 commits October 18, 2025 02:54
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
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 documentation files Oct 18, 2025
Copilot AI requested a review from chenjiahan October 18, 2025 03:02
@chenjiahan chenjiahan marked this pull request as ready for review October 18, 2025 09:51
Copilot AI review requested due to automatic review settings October 18, 2025 09:51
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 English clarity and naturalness in documentation files by fixing awkward phrasing that indicated direct translation from Chinese. The changes make the documentation more idiomatic and professional for English readers while preserving all original meanings.

  • Replaced unnatural constructions with more fluent English phrasing
  • Improved consistency in verb tenses and terminology usage
  • Enhanced technical accuracy with proper compiler terminology

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
website/docs/en/guide/start/quick-start.mdx Improved phrasing in quick start guide and standardized tool name capitalization
website/docs/en/guide/start/index.mdx Enhanced introduction with more natural English and consistent verb tenses
website/docs/en/guide/optimization/build-performance.mdx Clarified optimization language and improved readability
website/docs/en/guide/faq/general.mdx Simplified phrasing and removed unnecessary articles
website/docs/en/guide/basic/static-assets.mdx Minor wording improvements for clarity
website/docs/en/guide/basic/server.mdx Enhanced clarity in server documentation
website/docs/en/guide/basic/html-template.mdx Improved template engine description
website/docs/en/guide/advanced/hmr.mdx Standardized product name capitalization
website/docs/en/guide/advanced/env-vars.mdx Fixed technical terminology and removed duplicate words

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

## Default variables

By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their specified values during the build:
By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their values during during the build:
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate word 'during' should be removed.

Suggested change
By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their values during during the build:
By default, Rsbuild uses [source.define](#using-define) to inject environment variables into your code, replacing them with their values during the build:

Copilot uses AI. Check for mistakes.
@chenjiahan chenjiahan merged commit e869902 into main Oct 18, 2025
10 of 11 checks passed
@chenjiahan chenjiahan deleted the copilot/improve-english-docs branch October 18, 2025 09:53
@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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants