docs: fix grammar and consistency errors in documentation#5930
Merged
chenjiahan merged 3 commits intomainfrom Aug 23, 2025
Merged
docs: fix grammar and consistency errors in documentation#5930chenjiahan merged 3 commits intomainfrom
chenjiahan merged 3 commits intomainfrom
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
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] Fix various documentation errors found across the website/docs directory, including typos, grammatical issues, and terminology inconsistencies.
- Do not need to update the cpsell config.
- Avoid making too many changes in a single PR; limit to less th...
docs: fix grammar and consistency errors in documentation
Aug 23, 2025
chenjiahan
approved these changes
Aug 23, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes various grammar, punctuation, and consistency errors across the English documentation in the Rsbuild website. The changes improve readability and correctness while maintaining the original meaning of the content.
- Fixed grammar issues including comma splices, subject-verb agreement, and redundant words
- Improved sentence structure by removing improper conjunctions and awkward phrasing
- Enhanced consistency in documentation formatting and word choices
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/start/glossary.mdx | Changed "every module" to "each module" for better clarity |
| website/docs/en/guide/start/features.mdx | Fixed subject-verb agreement: "All bundle sizes is" → "all bundle sizes are" |
| website/docs/en/guide/configuration/swc.mdx | Removed redundant "to" from "you must to choose" |
| website/docs/en/guide/basic/output-files.mdx | Improved sentence structure by removing improper conjunction "And" |
| website/docs/en/config/source/define.mdx | Added missing comma in conditional statement |
| website/docs/en/config/resolve/dedupe.mdx | Fixed comma splice and removed unnecessary article "the" before "React" |
| website/docs/en/config/output/filename.mdx | Improved sentence flow by changing "Such as" to lowercase "such as" |
| website/docs/en/config/output/dist-path.mdx | Same sentence flow improvement as filename.mdx |
| website/docs/en/config/output/data-uri-limit.mdx | Same sentence flow improvement as other output config files |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes various grammar, punctuation, and consistency issues found across the English documentation in the
website/docs/en/directory.Issues Fixed
Grammar and Punctuation
resolve.dedupedocumentation: "usingresolve.dedupeto unify different major versions of a package, it may cause" → "usingresolve.dedupeto unify different major versions of a package may cause"source.definedocumentation: "If the value is a string it will be used" → "If the value is a string, it will be used"Consistency and Clarity
webpackChunkName→webpackChunkNameFiles Modified (9 total)
website/docs/en/config/resolve/dedupe.mdxwebsite/docs/en/config/output/filename.mdxwebsite/docs/en/config/output/dist-path.mdxwebsite/docs/en/config/output/data-uri-limit.mdxwebsite/docs/en/guide/start/features.mdxwebsite/docs/en/config/source/define.mdxwebsite/docs/en/guide/configuration/swc.mdxwebsite/docs/en/guide/start/glossary.mdxwebsite/docs/en/guide/basic/output-files.mdxThe corresponding Chinese documentation was checked and found to not require similar changes as the issues were English-specific. All changes are minimal and surgical, maintaining the original meaning while improving readability and correctness.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.