Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 3, 2025

Overview

This PR improves the English documentation in the website/docs/en directory by replacing non-authentic phrasing with more natural, idiomatic English expressions. The improvements maintain the original technical meaning while making the documentation more professional and easier to read for both native and non-native English speakers.

Changes Made

Improved 12 documentation files across various sections:

Guide Documentation

  • Basic guides: output-files.mdx, cli.mdx, server.mdx, static-assets.mdx
  • Optimization guides: build-performance.mdx, code-splitting.mdx, inline-assets.mdx
  • Styling guides: css-modules.mdx
  • Start guides: index.mdx
  • Advanced guides: env-vars.mdx

Configuration Documentation

  • Output config: data-uri-limit.mdx
  • Server config: proxy.mdx

Examples of Improvements

Before: "Rsbuild optimizes build performance by default, but as projects become larger, you may encounter build performance issues."
After: "Rsbuild optimizes build performance by default, but you may encounter performance issues as your project grows larger."

Before: "If you do not want /api to be passed along, we need to rewrite the path:"
After: "If you don't want /api to be passed along, we need to rewrite the path:"

Before: "Although the above method can provide the type of CSS Modules, it cannot accurately prompt which classNames are exported by a certain CSS file."
After: "The above method provides types for CSS Modules, but cannot accurately indicate which class names are exported by a specific CSS file."

Principles Applied

  • Replaced verbose or overly complex phrasing with concise, natural English
  • Simplified sentence structures while preserving technical accuracy
  • Improved preposition and article usage
  • Used contractions where appropriate for a more natural tone
  • Removed unnecessary qualifiers (e.g., "Please" in warnings)
  • Standardized terminology across files

Impact

  • Total: 110 lines modified across 12 files
  • No changes to code examples, configuration schemas, or technical content
  • All original meanings and technical accuracy preserved
  • Documentation is now more professional and easier to understand
Original prompt

Help me to improve the website/docs/en directory of the English document, many of the paragraphs are translated from Chinese, please find out these sentences are not authentic, without changing the original meaning of the case, replaced by more authentic English expression, the goal is to be more in line with the expression of the English open-source project's professional documents.

  • Avoid making too many changes in a single PR; limit to less than 20 files.
  • If you have modified English documentation in the "docs/en" directory, check the corresponding files with the same name in the "docs/zh" directory to confirm whether you want to make the same changes to the Chinese documentation.
  • PR title starts with "docs:"
  • If changing a sentence doesn't make a noticeable improvement, do not change it
  • Use simple wording to make it easier for non-native English users.
  • Don't change the meaning of the original sentence

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@netlify
Copy link

netlify bot commented Oct 3, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 9c575d9
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68e12e747b971500085d8b0d
😎 Deploy Preview https://deploy-preview-6302--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: 55 (🔴 down 14 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 3, 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 2 commits October 3, 2025 09:24
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 Help me to improve the website/docs/en directory of the English document, many of the paragraphs are translated from Chinese, please find out these sentences are not authentic, without changing the original meaning of the case, replaced by more authent... docs: improve English documentation authenticity and clarity Oct 3, 2025
Copilot finished work on behalf of chenjiahan October 3, 2025 09:30
Copilot AI requested a review from chenjiahan October 3, 2025 09:30
@chenjiahan chenjiahan changed the title docs: improve English documentation authenticity and clarity docs: improve documentation authenticity and clarity Oct 4, 2025
@chenjiahan chenjiahan marked this pull request as ready for review October 4, 2025 13:53
Copilot AI review requested due to automatic review settings October 4, 2025 13:53
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

Improve the authenticity and clarity of English documentation across Rsbuild guides and config docs by refining phrasing while preserving technical meaning.

  • Standardize terminology and simplify sentences for readability
  • Clarify configuration descriptions and tips without altering behavior
  • Maintain consistency in references and links across docs

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
website/docs/en/guide/styling/css-modules.mdx Refines explanations and instructions for CSS Modules usage and type generation.
website/docs/en/guide/optimization/inline-assets.mdx Clarifies inlining behaviors, configuration, and TypeScript declarations; improves tip language.
website/docs/en/guide/optimization/code-splitting.mdx Polishes strategy descriptions, notes, and customization guidance.
website/docs/en/guide/optimization/build-performance.mdx Tightens language around profiling, caching, tooling, and dev-mode optimizations.
website/docs/en/guide/basic/static-assets.mdx Improves definition and explanation of static assets.
website/docs/en/guide/basic/server.mdx Clarifies base path usage and routing behavior.
website/docs/en/guide/basic/output-files.mdx Refines descriptions of output structure and dev-mode behavior.
website/docs/en/guide/basic/cli.mdx Streamlines CLI usage explanations and option descriptions.
website/docs/en/guide/advanced/env-vars.mdx Clarifies environment variable injection timing and defaults.
website/docs/en/config/server/proxy.mdx Improves proxy config explanations and wording for options.
website/docs/en/config/output/data-uri-limit.mdx Clarifies thresholds and examples for inlining assets.

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

chenjiahan and others added 2 commits October 4, 2025 22:23
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@chenjiahan chenjiahan merged commit 6cff60c into main Oct 4, 2025
10 of 11 checks passed
@chenjiahan chenjiahan deleted the copilot/fix-fa960593-9d1f-4fc9-ae2a-286585b41a3f branch October 4, 2025 15:12
@chenjiahan chenjiahan mentioned this pull request Oct 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

3 participants