Skip to content

docs: fix grammar, punctuation, and clarity issues#5936

Merged
chenjiahan merged 3 commits intomainfrom
copilot/fix-0b42c88a-62c8-45ef-8f33-7b80a17b4c56
Aug 24, 2025
Merged

docs: fix grammar, punctuation, and clarity issues#5936
chenjiahan merged 3 commits intomainfrom
copilot/fix-0b42c88a-62c8-45ef-8f33-7b80a17b4c56

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 24, 2025 •
edited
Loading

This PR fixes various documentation errors found across the website/docs/en/ directory, focusing on grammatical correctness, punctuation consistency, and clarity improvements.

Issues Fixed

Article Usage

  • Fixed incorrect article usage with HTML: "a HTML" → "an HTML"
  • Corrected instances in inline assets, plugin hooks, and configuration documentation

Abbreviation Formatting

  • Standardized formatting for "e.g." to include proper comma: "e.g." → "e.g.,"
  • Applied consistent formatting across environment variables, plugin core, and output files documentation

Spacing and Punctuation

  • Fixed missing space after periods in sentences
  • Corrected "project.So if" → "project. So if" in bundle optimization guide

Grammar Improvements

  • Fixed plural agreement: "size of image" → "size of images" for consistency
  • Improved sentence structure and clarity

Redundant Language Removal

  • Simplified "and also" constructions to just "and" for better flow
  • Removed unnecessary "also" in 4 different files including server configuration, CSS usage, and Rspack configuration

Word Choice Simplification

  • Replaced formal "utilize" with clearer "use" in server compression documentation
  • Maintained technical accuracy while improving readability

Files Changed (12 total)

All changes are in English documentation files under website/docs/en/:

  • Configuration files: config/performance/prefetch.mdx, config/server/compress.mdx, config/server/open.mdx
  • Guide files: guide/optimization/inline-assets.mdx, guide/optimization/optimize-bundle.mdx, guide/basic/output-files.mdx, guide/advanced/env-vars.mdx, guide/styling/css-usage.mdx, guide/configuration/rspack.mdx
  • Plugin documentation: plugins/dev/hooks.mdx, plugins/dev/core.mdx
  • Community releases: community/releases/v0-7.mdx

Validation

  • ✅ All changes pass spell check and linting
  • ✅ Chinese documentation reviewed - no similar issues found
  • ✅ Changes maintain original meaning while improving clarity
  • ✅ Stayed within the 20-file limit as requested

These improvements enhance the overall quality and professionalism of the documentation while maintaining consistency across the codebase.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 24, 2025 •
edited
Loading

✅ Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit d5edcf7
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68aa9fc11d5a080008a17e7d
😎 Deploy Preview https://deploy-preview-5936--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 71 (no change from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Aug 24, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI and others added 2 commits August 24, 2025 05:10
@chenjiahan
docs: fix article usage, abbreviation formatting, and spacing issues
4fe4022 
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
@chenjiahan
docs: improve clarity by removing redundant language and simplifying …
d5edcf7 
…word choice

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, punctuation, and clarity issues in English documentation Aug 24, 2025
Copilot AI requested a review from chenjiahan August 24, 2025 05:15
@chenjiahan chenjiahan changed the title docs: fix grammar, punctuation, and clarity issues in English documentation docs: fix grammar, punctuation, and clarity issues Aug 24, 2025
@chenjiahan chenjiahan marked this pull request as ready for review August 24, 2025 09:16
Copilot AI review requested due to automatic review settings August 24, 2025 09:16
@chenjiahan chenjiahan enabled auto-merge (squash) August 24, 2025 09:16
Copilot AI reviewed Aug 24, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves documentation quality by fixing grammatical errors, punctuation inconsistencies, and clarity issues across 12 English documentation files in the website/docs/en/ directory.

Key changes include:

  • Correcting article usage ("a HTML" → "an HTML") for proper grammar
  • Standardizing abbreviation formatting ("e.g." → "e.g.,") for consistency
  • Removing redundant language ("and also" → "and") for better flow

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/docs/en/plugins/dev/hooks.mdx Fixed article usage for HTML
website/docs/en/plugins/dev/core.mdx Standardized "e.g." formatting across multiple lines
website/docs/en/guide/styling/css-usage.mdx Removed redundant "also" for cleaner flow
website/docs/en/guide/optimization/optimize-bundle.mdx Fixed grammar and spacing issues
website/docs/en/guide/optimization/inline-assets.mdx Corrected article usage for HTML
website/docs/en/guide/configuration/rspack.mdx Removed redundant "also"
website/docs/en/guide/basic/output-files.mdx Added missing comma after "etc."
website/docs/en/guide/advanced/env-vars.mdx Standardized "e.g." formatting
website/docs/en/config/server/open.mdx Removed redundant "also"
website/docs/en/config/server/compress.mdx Replaced formal "utilize" with clearer "use"
website/docs/en/config/performance/prefetch.mdx Fixed article usage for HTML
website/docs/en/community/releases/v0-7.mdx Removed redundant "also"

@chenjiahan chenjiahan disabled auto-merge August 24, 2025 09:23
@chenjiahan chenjiahan merged commit ae8452d into main Aug 24, 2025
20 of 21 checks passed
@chenjiahan chenjiahan deleted the copilot/fix-0b42c88a-62c8-45ef-8f33-7b80a17b4c56 branch August 24, 2025 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

+1 more reviewer

@chenjiahan chenjiahan chenjiahan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@chenjiahan chenjiahan

Copilot code review Copilot

Labels

release: document

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CLAassistant @chenjiahan