Skip to content

docs: fix documentation errors, grammar, typos, and file references#5892

Merged
chenjiahan merged 4 commits intomainfrom
copilot/fix-e42b235b-f270-4b40-838d-7ddf550d294c
Aug 20, 2025
Merged

docs: fix documentation errors, grammar, typos, and file references#5892
chenjiahan merged 4 commits intomainfrom
copilot/fix-e42b235b-f270-4b40-838d-7ddf550d294c

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 20, 2025

This PR fixes various documentation errors found across the website/docs directory, including typos, grammatical issues, and terminology inconsistencies.

Changes Made

Grammar and Language Fixes

  • root.mdx: Fixed grammatical error "is also be passed" → "is also passed"
  • json-files.mdx: Fixed verb form "supports import JSON" → "supports importing JSON"
  • build-cache.mdx: Fixed singular/plural agreement "arrays" → "array"
  • static-deploy.mdx: Added missing period in GitHub Pages description and fixed subject-verb agreement "outputs typically includes" → "outputs typically include"

Clarity Improvements

  • output-files.mdx: Improved clarity by changing "same level directory" → "same directory"

File Reference Corrections

  • json-files.mdx: Removed incorrect title="src/env.d.ts" from JavaScript code block that was importing a TOML file

Validation

  • All changes passed spell checking with cspell
  • Formatting validated with prettier
  • Verified corresponding Chinese documentation files are already correct
  • Changes are minimal and preserve existing documentation structure and style

These fixes improve the overall quality and readability of the Rsbuild documentation while maintaining consistency across all files.


✨ 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 20, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 2e5d769
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/68a55b9a42bd190008525a81
😎 Deploy Preview https://deploy-preview-5892--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: 78 (🟢 up 3 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 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.

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: grammar, typos, and file references Aug 20, 2025
Copilot AI requested a review from chenjiahan August 20, 2025 05:11
@chenjiahan chenjiahan changed the title Fix documentation errors: grammar, typos, and file references docs: fix documentation errors: grammar, typos, and file references Aug 20, 2025
@chenjiahan chenjiahan marked this pull request as ready for review August 20, 2025 05:22
Copilot AI review requested due to automatic review settings August 20, 2025 05:22
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 documentation errors across the website/docs directory, including grammatical mistakes, spelling issues, and clarity improvements in the English documentation files.

  • Grammar corrections (verb forms, subject-verb agreement, unnecessary words)
  • Clarity improvements for better readability
  • Punctuation fixes (missing periods)

Reviewed Changes

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

Show a summary per file
File Description
website/docs/en/guide/basic/static-deploy.mdx Fixed subject-verb agreement "includes" → "include" and added missing period
website/docs/en/guide/basic/output-files.mdx Improved clarity by changing "same level directory" → "same directory"
website/docs/en/guide/basic/json-files.mdx Fixed verb form "supports import" → "supports importing"
website/docs/en/config/root.mdx Removed unnecessary "be" from "is also be passed" → "is also passed"
website/docs/en/config/performance/build-cache.mdx Fixed singular/plural agreement "arrays" → "array"

@chenjiahan chenjiahan changed the title docs: fix documentation errors: grammar, typos, and file references docs: fix documentation errors, grammar, typos, and file references Aug 20, 2025
@chenjiahan chenjiahan merged commit ee3e9b0 into main Aug 20, 2025
11 of 12 checks passed
@chenjiahan chenjiahan deleted the copilot/fix-e42b235b-f270-4b40-838d-7ddf550d294c branch August 20, 2025 05:25
@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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants