Skip to content

docs: fix various documentation errors#5896

Merged
chenjiahan merged 3 commits intomainfrom
copilot/fix-4127483b-60b9-49c4-8fd0-814c7362dc4f
Aug 20, 2025
Merged

docs: fix various documentation errors#5896
chenjiahan merged 3 commits intomainfrom
copilot/fix-4127483b-60b9-49c4-8fd0-814c7362dc4f

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 20, 2025

This PR fixes several grammatical errors, terminology inconsistencies, and minor wording issues found across the English documentation in the website/docs/en directory.

Fixed Issues

Grammatical Errors

  • output-files.mdx: Fixed "source map file" → "source map files" for consistency with other plural items in the list
  • server.mdx: Fixed missing word "If you to access" → "If you want to access"
  • server.mdx: Fixed singular/plural inconsistency "routing convention" → "routing conventions"
  • plugins/dev/index.mdx: Fixed comparative form "more simple" → "simpler"
  • framework/react.mdx: Fixed verb form "supports convert" → "supports converting"

Terminology and Wording

  • glossary.mdx: Improved wording "See more glossary" → "See additional glossary terms"
  • environments.mdx: Removed redundant word usage "respectively... respectively" → cleaner phrasing

Validation

  • ✅ All changes pass linting (pnpm lint)
  • ✅ All changes pass spell checking (pnpm check-spell)
  • ✅ Corresponding Chinese documentation reviewed for consistency (no changes needed)

These changes improve the overall readability and professionalism of the documentation while maintaining consistency across the codebase. All fixes are minimal and surgical, focusing only on clear grammatical or terminology issues.


💡 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.

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 20, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 61ee27d
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68a5ccef65d2ca000814e836
😎 Deploy Preview https://deploy-preview-5896--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: 72 (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.

Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Aug 20, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ chenjiahan
❌ Copilot
You have signed the CLA already but the status is still pending? Let us recheck it.

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 Aug 20, 2025
Copilot AI requested a review from chenjiahan August 20, 2025 10:21
@chenjiahan chenjiahan marked this pull request as ready for review August 20, 2025 13:26
Copilot AI review requested due to automatic review settings August 20, 2025 13:26
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 fixes various grammatical errors, terminology inconsistencies, and minor wording issues across the English documentation in the website/docs/en directory. The changes improve readability and professionalism while maintaining consistency.

Key Changes

  • Fixed grammatical errors including verb forms, missing words, and singular/plural inconsistencies
  • Improved terminology and wording for clarity
  • Corrected comparative forms and redundant phrasing

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
website/docs/en/plugins/dev/index.mdx Fixed comparative form "more simple" → "simpler"
website/docs/en/guide/start/glossary.mdx Improved wording "See more glossary" → "See additional glossary terms"
website/docs/en/guide/framework/react.mdx Fixed verb form "supports convert" → "supports converting"
website/docs/en/guide/basic/server.mdx Fixed missing word "If you to access" → "If you want to access" and plural consistency
website/docs/en/guide/basic/output-files.mdx Fixed singular/plural consistency "source map file" → "source map files"
website/docs/en/guide/advanced/environments.mdx Removed redundant word usage for cleaner phrasing

@chenjiahan chenjiahan merged commit 1d8fc05 into main Aug 20, 2025
10 of 11 checks passed
@chenjiahan chenjiahan deleted the copilot/fix-4127483b-60b9-49c4-8fd0-814c7362dc4f branch August 20, 2025 13:28
@chenjiahan chenjiahan mentioned this pull request Aug 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants