docs: fix grammar issues and contractions#5934
Merged
chenjiahan merged 3 commits intomainfrom Aug 24, 2025
Merged
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 issues and contractions in English documentation
Aug 23, 2025
chenjiahan
approved these changes
Aug 24, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation quality by fixing grammar issues and replacing informal contractions with formal equivalents across 19 documentation files in the website/docs/en directory.
- Fixed grammatical error by adding "that" in the phrase "making sure the TypeScript can correctly identify" → "making sure that TypeScript can correctly identify"
- Replaced contractions with formal equivalents (e.g.,
it's→it is,doesn't→does not,won't→will not) - Enhanced professional tone while maintaining technical accuracy
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/plugins/list/plugin-svgr.mdx | Fixed grammar by adding "that" in TypeScript identification phrase |
| website/docs/en/plugins/list/plugin-react.mdx | Replaced "it's" with "it is" in React Profiler documentation |
| website/docs/en/plugins/list/plugin-less.mdx | Replaced "doesn't" with "does not" in FAQ section |
| website/docs/en/guide/styling/css-modules.mdx | Fixed grammar by adding "that" in TypeScript identification phrase |
| website/docs/en/guide/migration/webpack.mdx | Replaced "let's" with "let us" in React migration example |
| website/docs/en/guide/migration/vite-plugin.mdx | Replaced "Here's" with "Here is" in HTML title example |
| website/docs/en/guide/framework/react.mdx | Replaced "it's" with "it is" in React Compiler documentation |
| website/docs/en/guide/configuration/rspack.mdx | Replaced "Here's" with "Here is" in basic example |
| website/docs/en/guide/basic/static-assets.mdx | Fixed grammar by adding "that" in TypeScript identification phrase |
| website/docs/en/guide/advanced/ssr.mdx | Replaced "you'll" with "you will" and "Here's" with "Here is" in SSR documentation |
| website/docs/en/config/tools/rspack.mdx | Replaced "won't" with "will not" in Rspack config documentation |
| website/docs/en/config/tools/bundler-chain.mdx | Replaced "won't" with "will not" in bundler chain documentation |
| website/docs/en/config/source/define.mdx | Replaced "isn't" with "is not" in define config documentation |
| website/docs/en/config/performance/print-file-size.mdx | Replaced multiple instances of "don't" with "do not" |
| website/docs/en/config/performance/preload.mdx | Replaced "doesn't" with "does not" in preload documentation |
| website/docs/en/config/performance/bundle-analyze.mdx | Replaced "don't" with "do not" in bundle analyze documentation |
| website/docs/en/config/output/legal-comments.mdx | Replaced "won't" with "will not" in legal comments documentation |
| website/docs/en/config/output/filename.mdx | Replaced "don't" with "do not" in filename documentation |
| website/docs/en/community/releases/v1-0.mdx | Replaced "let's" with "let us" in plugin implementation example |
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 addresses various documentation errors found across the
website/docs/endirectory, focusing on grammar issues and contractions that should be avoided in formal documentation.Changes Made
Grammar Fixes
Contraction Replacements
Replaced informal contractions with formal equivalents to maintain professional documentation standards:
it's→it is(2 instances)doesn't→does not(2 instances)let's→let us(2 instances)won't→will not(3 instances)Here's→Here is(3 instances)you'll→you will(1 instance)don't→do not(5 instances)isn't→is not(1 instance)Files Modified (19 total)
The changes span various documentation sections including:
guide/styling/css-modules.mdx,plugins/list/plugin-svgr.mdx)config/performance/preload.mdx,config/tools/bundler-chain.mdx)guide/migration/webpack.mdx,guide/migration/vite-plugin.mdx)plugins/list/plugin-react.mdx,plugins/list/plugin-less.mdx)Validation
These improvements enhance the professional tone and readability of the documentation while maintaining technical accuracy.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.