docs: fix terminology inconsistencies and grammar issues#5895
Merged
chenjiahan merged 4 commits intomainfrom Aug 20, 2025
Merged
docs: fix terminology inconsistencies and grammar issues#5895chenjiahan 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 terminology inconsistencies and grammar issues across documentation
Aug 20, 2025
chenjiahan
reviewed
Aug 20, 2025
chenjiahan
approved these changes
Aug 20, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes terminology inconsistencies and grammar issues across the Rsbuild documentation to improve clarity and maintain consistency. The changes focus on standardizing technical terms and correcting grammatical errors without affecting code functionality.
Key changes include:
- Standardized terminology: "Source Map" → "source map", "Toml" → "TOML", "builtin" → "built-in"
- Fixed grammar issues: verb tense corrections and subject-verb agreement improvements
- Applied changes consistently across both English and Chinese documentation
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
website/docs/zh/guide/start/glossary.mdx |
Updated Chinese translation to use consistent terminology for bundlers |
website/docs/zh/guide/migration/webpack.mdx |
Fixed TOML capitalization in Chinese documentation table |
website/docs/en/guide/start/glossary.mdx |
Corrected grammar for bundler descriptions and browser data fetching |
website/docs/en/guide/migration/webpack.mdx |
Standardized TOML capitalization in migration guide table |
website/docs/en/guide/basic/output-files.mdx |
Changed "Source Map" to lowercase "source map" for consistency |
website/docs/en/guide/basic/json-files.mdx |
Updated TOML capitalization throughout the JSON files guide |
website/docs/en/config/output/filename.mdx |
Fixed subject-verb agreement: "Rsbuild only set" → "Rsbuild only sets" |
website/docs/en/api/javascript-api/dev-server-api.mdx |
Changed "builtin" to "built-in" for better readability |
Merged
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/docs directory, including terminology inconsistencies and grammatical issues.
Changes Made
Terminology Consistency Fixes
Grammar and Language Improvements
Files Modified
English Documentation (6 files):
website/docs/en/api/javascript-api/dev-server-api.mdxwebsite/docs/en/guide/basic/json-files.mdxwebsite/docs/en/guide/basic/output-files.mdxwebsite/docs/en/guide/migration/webpack.mdxwebsite/docs/en/guide/start/glossary.mdxwebsite/docs/en/config/output/filename.mdxChinese Documentation (2 files):
website/docs/zh/guide/migration/webpack.mdxwebsite/docs/zh/guide/start/glossary.mdxAll changes have been verified with linting and spell checking to ensure no new issues were introduced.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.