docs: polish start and FAQ docs#6848
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR polishes the English in three documentation files to improve clarity and readability while preserving technical accuracy. The changes make the documentation more idiomatic and easier to understand for English readers.
Key changes:
- Simplified and streamlined wording throughout (e.g., "default configurations" → "defaults", "compilation of" → "support for")
- Improved sentence flow and grammar (e.g., adding articles like "the", restructuring phrases for clarity)
- Standardized terminology with proper hyphenation for compound adjectives ("best-practice", "open-source")
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
website/docs/en/guide/start/index.mdx |
Simplified terminology, improved sentence flow, and made phrasing more natural throughout the introduction and feature descriptions |
website/docs/en/guide/start/glossary.mdx |
Enhanced clarity in technical definitions, improved readability with more natural phrasing, and standardized hyphenation |
website/docs/en/guide/faq/general.mdx |
Refined explanations of relationships between tools, improved sentence structure, and standardized compound adjective formatting |
I found no issues with this PR. All changes are legitimate English improvements that enhance clarity and readability while maintaining technical accuracy. The documentation changes are well-executed and align perfectly with the stated goal of polishing the English in these files.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Motivation
website/docs/enthat were translated from Chinese.website/docs/zhfiles for consistency (no zh edits were required).Description
website/docs/en/guide/start/index.mdx,website/docs/en/guide/start/glossary.mdx, andwebsite/docs/en/guide/faq/general.mdxto improve readability.best-practice,open-source, and sentence-flow improvements).Testing
pnpm lint, which completed successfully with no errors.Codex Task