Skip to content

docs: improve clarity in documentation files#6429

Merged
chenjiahan merged 2 commits intomainfrom
copilot/improve-english-docs
Oct 25, 2025
Merged

docs: improve clarity in documentation files#6429
chenjiahan merged 2 commits intomainfrom
copilot/improve-english-docs

Conversation

Copy link
Contributor

Copilot AI commented Oct 25, 2025

Improved English readability in documentation translated from Chinese. Changes focus on removing awkward phrasing and making the tone more direct and professional.

Changes by file

guide/advanced/env-vars.mdx

  • Fixed typo: "during during the build" → "during the build"
  • Technical term accuracy: "invalid code" → "dead code"

guide/basic/static-assets.mdx

  • Removed excessive "please" usage for more professional tone
  • Simplified sentence structure in public folder usage notes

guide/optimization/build-performance.mdx

  • Clarified: "at dev startup" → "during dev server startup"

guide/basic/server.mdx

  • Improved consistency: "the HTML page" → "HTML pages" where contextually appropriate
  • Condensed comparison descriptions

guide/optimization/optimize-bundle.mdx

  • Removed verbose phrases: "of online users", "we will introduce"
  • Made instructions more direct: "We can eliminate" → "You can eliminate"
  • Simplified technical explanations for image compression and chunk splitting

All changes preserve original meaning and technical accuracy while improving readability for non-native English speakers.

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 Oct 25, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 3e4b6cd
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68fc154ad228750008012ac8
😎 Deploy Preview https://deploy-preview-6429--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 (🟢 up 8 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 in English documentation docs: improve English clarity in 5 documentation files Oct 25, 2025
Copilot AI requested a review from chenjiahan October 25, 2025 00:11
@chenjiahan chenjiahan changed the title docs: improve English clarity in 5 documentation files docs: improve clarity in documentation files Oct 25, 2025
@chenjiahan chenjiahan marked this pull request as ready for review October 25, 2025 11:36
Copilot AI review requested due to automatic review settings October 25, 2025 11:36
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 professionalism of English documentation that was originally translated from Chinese. The changes remove awkward phrasing, excessive politeness markers, and verbose constructions while maintaining technical accuracy.

Key changes:

  • Corrected technical terminology (e.g., "invalid code" → "dead code")
  • Removed unnecessary phrases ("of online users", "we will introduce")
  • Fixed typos and improved sentence flow

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
guide/advanced/env-vars.mdx Fixed duplicate word typo and corrected technical term to "dead code"
guide/basic/static-assets.mdx Removed excessive "please" usage and simplified sentence structures
guide/optimization/build-performance.mdx Clarified timing reference for lazy compilation
guide/basic/server.mdx Improved consistency in terminology and condensed comparison text
guide/optimization/optimize-bundle.mdx Removed verbose phrases and made instructions more direct

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

@chenjiahan chenjiahan merged commit b19f888 into main Oct 25, 2025
20 of 21 checks passed
@chenjiahan chenjiahan deleted the copilot/improve-english-docs branch October 25, 2025 11:39
@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