docs: fix grammatical errors and terminology inconsistencies#5893
Merged
chenjiahan merged 3 commits intomainfrom Aug 20, 2025
Merged
docs: fix grammatical errors and terminology inconsistencies#5893chenjiahan 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 grammatical errors and terminology inconsistencies
Aug 20, 2025
chenjiahan
approved these changes
Aug 20, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the overall quality and consistency of Rsbuild documentation by addressing grammatical errors, awkward phrasing, and terminology inconsistencies across multiple documentation files. The changes focus on enhancing readability and maintaining professional technical writing standards.
- Standardized terminology from informal "configs" to proper "configurations" or "configuration options"
- Fixed grammatical issues and improved sentence flow throughout documentation
- Applied consistent phrasing improvements across both English and Chinese documentation
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/config/source/define.mdx |
Fixed comment phrasing from "Turn into being..." to "Turns into" |
website/docs/en/guide/start/index.mdx |
Updated "build configs" to "build configurations" for consistency |
website/docs/en/guide/debug/debug-mode.mdx |
Removed unnecessary article "the" and improved terminology |
website/docs/en/guide/basic/server.mdx |
Standardized "configs" to "configurations" and "configuration options" |
website/docs/en/guide/basic/output-files.mdx |
Updated terminology and improved list introduction formatting |
website/docs/en/guide/basic/html-template.mdx |
Changed "configs" to "configuration options" for consistency |
website/docs/en/guide/basic/cli.mdx |
Updated CLI help text to use "configurations" instead of "configs" |
website/docs/en/guide/advanced/environments.mdx |
Applied consistent terminology throughout environment documentation |
website/docs/en/config/source/define.mdx |
Fixed comment phrasing to match Chinese documentation |
website/docs/en/api/start/index.mdx |
Updated terminology to use "configurations" for consistency |
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.
This PR fixes various documentation errors found across the website/docs directory, including grammatical issues, awkward phrasing, and terminology inconsistencies.
Changes Made
Grammar and Phrasing Improvements
Terminology Consistency
Files Modified
website/docs/en/config/source/define.mdx- Fixed code comment phrasingwebsite/docs/en/guide/debug/debug-mode.mdx- Removed unnecessary articles and improved grammarwebsite/docs/en/guide/basic/html-template.mdx- Updated terminology for consistencywebsite/docs/en/guide/basic/output-files.mdx- Improved list formatting and terminologywebsite/docs/en/guide/basic/server.mdx- Enhanced grammar and consistencywebsite/docs/en/guide/basic/cli.mdx- Standardized terminologywebsite/docs/en/guide/advanced/environments.mdx- Fixed grammar and terminologywebsite/docs/en/api/start/index.mdx- Improved terminology consistencywebsite/docs/en/guide/start/index.mdx- Enhanced introduction claritywebsite/docs/zh/config/source/define.mdx- Applied same phrasing fixes to Chinese docsAll changes maintain the original meaning while improving readability and maintaining consistency with professional technical writing standards. The modifications passed all linting and spell-checking requirements.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.