docs: fix various documentation errors#5903
Merged
chenjiahan merged 6 commits intomainfrom Aug 21, 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>
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
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 various documentation errors across website/docs directory
Aug 21, 2025
chenjiahan
approved these changes
Aug 21, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes various documentation errors across the Rsbuild website documentation to improve consistency and correctness. The changes primarily address API usage errors, punctuation inconsistencies, grammar issues, and word usage standardization.
- Fixed incorrect API usage example in JavaScript API documentation
- Corrected punctuation and grammar issues throughout multiple documentation files
- Standardized word usage for better consistency
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/migration/rsbuild-0-x.mdx | Fixed "can not" → "cannot" and capitalization error |
| website/docs/en/guide/framework/preact.mdx | Corrected subject-verb agreement and plural consistency |
| website/docs/en/config/output/filename.mdx | Added missing article "the" before "bundler" |
| website/docs/en/api/start/index.mdx | Removed redundant pronoun "it" |
| website/docs/en/api/javascript-api/instance.mdx | Fixed API usage example and Chinese punctuation marks |
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 several documentation errors found across the website/docs directory, including typos, grammatical issues, and terminology inconsistencies:
Issues Fixed
API Usage Error
api.getNormalizedConfig()should bersbuild.getNormalizedConfig()in the example code for thersbuild.getNormalizedConfigmethod.Punctuation Inconsistencies
Grammar Errors
Missing Articles
Word Usage Consistency
Verification
These fixes improve the overall quality and consistency of the Rsbuild documentation while maintaining the existing structure and content.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.