Skip to content

docs: fix grammar, spelling, and consistency errors in documentation#5888

Merged
chenjiahan merged 4 commits intomainfrom
copilot/fix-8a2f0629-7e1a-4368-bbb4-6ca5f8da857b
Aug 20, 2025
Merged

docs: fix grammar, spelling, and consistency errors in documentation#5888
chenjiahan merged 4 commits intomainfrom
copilot/fix-8a2f0629-7e1a-4368-bbb4-6ca5f8da857b

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 20, 2025

This PR fixes various documentation errors found across the website/docs directory, including typos, grammatical issues, and terminology inconsistencies.

Changes Made

Dictionary Updates

  • Added missing capitalized technical terms to the spell checker dictionary (scripts/dictionary.txt):
    • Rsbuild, Rsbuild's, Rspack, Rslib, Rsdoctor, Rslint, Rslog, Rspeedy, Rspress, Rstack, Rstest

Grammar and Spelling Fixes

Fixed multiple grammatical errors in English documentation:

  • Verb agreement: "will introduces" → "introduces"
  • Pronoun errors: "writing then to disk" → "writing them to disk"
  • Preposition issues: "output path of through" → "output path through"
  • Word choice: "uniformly input" → "uniformly output"
  • Verb forms: "will seems like" → "will look like", "will logs errors" → "will log errors"
  • Duplicate words: "server-rendered rendered" → "server-rendered content"
  • Article usage: "an unique" → "a unique"
  • Gerund forms: "After turn on" → "After turning on"

Consistency Improvements

  • File descriptions: "is a basic directory for" → "shows the basic directory structure for"
  • Punctuation: Fixed inconsistent comma usage in lists
  • Articles: Standardized "root of dist directory" → "root of the dist directory"
  • Terminology: "scripts files" → "script files", "and add" → "and have" for suffix descriptions
  • Missing articles: "we have following" → "we have the following"

Cross-language Fixes

  • Fixed punctuation inconsistencies in Chinese documentation to match the corrected English versions

Verification

  • All fixes verified with the project's spell checker (pnpm check-spell)
  • Full scan of 1,965 files now passes with 0 issues
  • Manual review of common error patterns completed

The changes improve readability and maintain consistency across the documentation while preserving all technical accuracy and meaning.


✨ 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
Copy Markdown

netlify Bot commented Aug 20, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 15e76e7
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68a550d66bcada000821501e
😎 Deploy Preview https://deploy-preview-5888--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: 72 (🟢 up 5 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
Copy Markdown

CLAassistant commented Aug 20, 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 August 20, 2025 03:01
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] Help me fix any documentation errors in the website/docs directory, including but not limited to typos, incorrect translations, inaccurate terminology, etc. Fix grammar, spelling, and consistency errors in documentation Aug 20, 2025
Copilot AI requested a review from chenjiahan August 20, 2025 03:15
@chenjiahan chenjiahan marked this pull request as ready for review August 20, 2025 04:36
Copilot AI review requested due to automatic review settings August 20, 2025 04:36

This comment was marked as outdated.

@chenjiahan chenjiahan changed the title Fix grammar, spelling, and consistency errors in documentation docs: fix grammar, spelling, and consistency errors in documentation Aug 20, 2025
Copy link
Copy Markdown
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 fixes various grammar, spelling, and consistency issues in the English and Chinese documentation across multiple files. The changes improve readability while preserving technical accuracy.

  • Grammar and verb agreement fixes (e.g., "will introduces" → "introduces", "will logs errors" → "will log errors")
  • Pronoun and preposition corrections (e.g., "writing then to disk" → "writing them to disk")
  • Article and terminology consistency improvements (e.g., "an unique" → "a unique", "scripts files" → "script files")

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/zh/guide/basic/output-files.mdx Fixed punctuation in Chinese documentation to match English corrections
website/docs/en/guide/migration/modern-builder.mdx Added missing article "the" before "dist directory"
website/docs/en/guide/migration/cra.mdx Corrected verb form from "will logs" to "will log"
website/docs/en/guide/basic/output-files.mdx Multiple grammar fixes including verb agreement, pronouns, prepositions, and article usage
website/docs/en/guide/advanced/ssr.mdx Fixed duplicate word "server-rendered rendered" to "server-rendered content"
website/docs/en/config/output/manifest.mdx Corrected article usage from "an unique" to "a unique"
website/docs/en/config/output/inline-styles.mdx Fixed grammar issues including gerund form and article usage
website/docs/en/config/output/inline-scripts.mdx Corrected terminology and grammar similar to inline-styles.mdx
website/docs/en/config/html/tags.mdx Fixed verb form from "will seems like" to "will look like"
website/docs/en/config/dev/write-to-disk.mdx Corrected pronoun from "then" to "them"

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

@chenjiahan chenjiahan merged commit 29e33fd into main Aug 20, 2025
11 of 12 checks passed
@chenjiahan chenjiahan deleted the copilot/fix-8a2f0629-7e1a-4368-bbb4-6ca5f8da857b branch August 20, 2025 04:38
@chenjiahan chenjiahan mentioned this pull request Aug 21, 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.

4 participants