docs: fix spelling, grammar, and style issues across documentation#5946
Merged
chenjiahan merged 4 commits intomainfrom Aug 26, 2025
Merged
docs: fix spelling, grammar, and style issues across documentation#5946chenjiahan merged 4 commits intomainfrom
chenjiahan merged 4 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 spelling, grammar, and style issues across documentation
Aug 25, 2025
chenjiahan
reviewed
Aug 26, 2025
chenjiahan
reviewed
Aug 26, 2025
chenjiahan
reviewed
Aug 26, 2025
chenjiahan
approved these changes
Aug 26, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR focuses on standardizing documentation language and style across the Rsbuild website to improve consistency and professionalism. The changes address spelling variations, grammar issues, and stylistic inconsistencies found throughout the documentation.
- Standardized American English spelling ("analyse" → "analyze")
- Replaced contractions with formal language ("don't" → "do not", "won't" → "will not", "they're" → "they are")
- Improved sentence structure and readability by removing redundant relative clauses and adding missing articles
Reviewed Changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/styling/css-usage.mdx | Changed contraction "don't" to "do not" |
| website/docs/en/guide/styling/css-modules.mdx | Changed contraction "don't" to "do not" |
| website/docs/en/guide/configuration/rspack.mdx | Changed contraction "won't" to "will not" |
| website/docs/en/guide/advanced/env-vars.mdx | Improved sentence flow by removing redundant "which" clause |
| website/docs/en/config/server/proxy.mdx | Changed contractions "don't" and "don't" to "do not" |
| website/docs/en/config/server/open.mdx | Changed contraction "don't" to "do not" |
| website/docs/en/config/server/html-fallback.mdx | Changed contraction "don't" to "do not" |
| website/docs/en/config/resolve/alias-strategy.mdx | Changed contraction "don't" to "do not" |
| website/docs/en/config/dev/lazy-compilation.mdx | Changed contraction "they're" to "they are" |
| website/docs/en/api/javascript-api/dev-server-api.mdx | Added missing article "a" before "custom server" |
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.
Fixed various documentation errors found across the
website/docsdirectory to improve consistency and readability.Changes Made
Spelling and Terminology
Grammar Improvements
Style and Readability
Files Modified (13 total)
English Documentation:
website/docs/en/api/javascript-api/dev-server-api.mdxwebsite/docs/en/community/releases/v1-0.mdxwebsite/docs/en/config/dev/lazy-compilation.mdxwebsite/docs/en/config/dev/setup-middlewares.mdxwebsite/docs/en/config/resolve/alias-strategy.mdxwebsite/docs/en/config/server/html-fallback.mdxwebsite/docs/en/config/server/open.mdxwebsite/docs/en/config/server/proxy.mdxwebsite/docs/en/guide/advanced/env-vars.mdxwebsite/docs/en/guide/configuration/rspack.mdxwebsite/docs/en/guide/styling/css-modules.mdxwebsite/docs/en/guide/styling/css-usage.mdxwebsite/docs/en/plugins/dev/core.mdxChinese Documentation:
website/docs/zh/plugins/dev/core.mdx(terminology consistency)All changes are surgical and preserve the original meaning while improving consistency and professionalism of the documentation.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.