Skip to content

docs: improve English clarity in documentation#12060

Merged
chenjiahan merged 3 commits intomainfrom
copilot/improve-english-docs
Nov 3, 2025
Merged

docs: improve English clarity in documentation#12060
chenjiahan merged 3 commits intomainfrom
copilot/improve-english-docs

Conversation

Copy link
Contributor

Copilot AI commented Nov 1, 2025

Rewrote unnatural English in 5 documentation files to sound more professional and native, following the pattern of high-quality open-source docs.

Changes

  • cache.mdx: Removed verbose phrasing ("will cache... and use them in the next build" → "caches... then reuses them in subsequent builds")
  • tree-shaking.mdx: Simplified awkward constructions ("terminology widely used within the JavaScript ecosystem defined as" → "term commonly used in the JavaScript ecosystem for"), fixed typo
  • compiler.mdx: Made descriptions more direct ("Before starting a new compilation, you must call compiler.close() in the callback function of compiler.run and wait for it to finish. Only then can you proceed" → "Before starting a new compilation, call compiler.close() in the compiler.run callback and wait for it to finish before calling compiler.run again")
  • hmr.mdx: Converted passive to active voice, clarified technical descriptions
  • experiments.mdx: Standardized experimental feature descriptions ("Once enabled, Rspack will output" → "When enabled, Rspack outputs")

All changes preserve original meaning while improving readability for non-native English speakers. Spell check and formatting pass.

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.

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

@netlify
Copy link

netlify bot commented Nov 1, 2025

Deploy Preview for rspack ready!

Name Link
🔨 Latest commit 4eadabb
🔍 Latest deploy log https://app.netlify.com/projects/rspack/deploys/69069f3a4f73da0008def596
😎 Deploy Preview https://deploy-preview-12060--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copilot AI and others added 2 commits November 1, 2025 23:57
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 of English documentation docs: improve English clarity in documentation Nov 2, 2025
Copilot AI requested a review from chenjiahan November 2, 2025 00:05
@chenjiahan chenjiahan marked this pull request as ready for review November 2, 2025 02:11
Copilot AI review requested due to automatic review settings November 2, 2025 02:11
@github-actions github-actions bot added the release: document release: document related release(mr only) label Nov 2, 2025
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 documentation clarity and conciseness across multiple English documentation files by simplifying language, reducing wordiness, and making the content more direct and easier to understand.

  • Rewrites sentences to be more concise and direct
  • Converts passive voice to active voice where appropriate
  • Simplifies complex sentence structures and removes redundant phrases

Reviewed Changes

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

Show a summary per file
File Description
website/docs/en/guide/optimization/tree-shaking.mdx Simplified explanations of tree shaking concepts, prerequisites, and configuration options
website/docs/en/config/experiments.mdx Made experimental features descriptions more concise and direct
website/docs/en/config/cache.mdx Streamlined cache configuration documentation
website/docs/en/api/runtime-api/hmr.mdx Clarified HMR API descriptions and usage examples
website/docs/en/api/javascript-api/compiler.mdx Improved clarity of Compiler API method descriptions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chenjiahan chenjiahan requested a review from 9aoy November 3, 2025 02:34
@chenjiahan chenjiahan merged commit 7b7c77c into main Nov 3, 2025
55 of 58 checks passed
@chenjiahan chenjiahan deleted the copilot/improve-english-docs branch November 3, 2025 02:58
@h-a-n-a h-a-n-a mentioned this pull request Nov 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release: document release: document related release(mr only)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants