docs: fix errors, contractions, terminology, and grammar improvements#5889
Merged
chenjiahan merged 3 commits intomainfrom Aug 20, 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>
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...
Fix documentation errors: contractions, terminology, and grammar improvements
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 standardizes documentation language by replacing contractions with formal language, correcting grammatical errors, and improving terminology consistency across the Rsbuild documentation. The changes focus on maintaining professional documentation standards while preserving clarity and meaning.
Key changes include:
- Contraction standardization: replacing informal contractions like "it's", "don't" with formal equivalents
- Grammar improvements: fixing plural forms, article usage, and sentence structure
- Minor terminology corrections for consistency
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/api/javascript-api/instance.mdx | Formal contraction replacement in note about method usage |
| website/docs/en/config/html/tags.mdx | Grammar improvement in security warning about XSS |
| website/docs/en/config/performance/chunk-split.mdx | Article removal and clarity improvement in reference text |
| website/docs/en/config/security/sri.mdx | Contraction replacement in configuration description |
| website/docs/en/config/source/define.mdx | Contraction replacement in bullet point |
| website/docs/en/guide/basic/output-files.mdx | Added "section" for clarity in introductory text |
| website/docs/en/guide/basic/static-deploy.mdx | Contraction replacement in GitHub Actions instruction |
| website/docs/en/guide/styling/tailwindcss.mdx | Corrected plural form and parallel structure in description |
| website/docs/en/guide/styling/tailwindcss-v3.mdx | Corrected plural form and parallel structure in description |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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 addresses various documentation errors found across the website/docs directory, including grammatical issues, contraction inconsistencies, and terminology standardization.
Changes Made
Contraction Standardization
Replaced informal contractions with formal language throughout the documentation to maintain consistency and professionalism:
it's→it is(5 instances)don't→do not(1 instance)Terminology Consistency
Standardized proper noun capitalization:
webpack→Webpackwhen referring to the tool name (not string literals)Grammar and Clarity Improvements
Files Modified (9 total)
website/docs/en/api/javascript-api/instance.mdxwebsite/docs/en/config/html/tags.mdxwebsite/docs/en/config/performance/chunk-split.mdxwebsite/docs/en/config/security/sri.mdxwebsite/docs/en/config/source/define.mdxwebsite/docs/en/guide/basic/output-files.mdxwebsite/docs/en/guide/basic/static-deploy.mdxwebsite/docs/en/guide/styling/tailwindcss.mdxwebsite/docs/en/guide/styling/tailwindcss-v3.mdxAll changes are minimal and surgical, preserving the original meaning while improving readability and maintaining consistent documentation standards. The fixes passed spell check and formatting validation.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.