docs: improve clarity in guide documentation#6479
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>
There was a problem hiding this comment.
Pull Request Overview
This PR refines the English documentation to improve clarity, conciseness, and consistency throughout the guide. The changes are primarily editorial, focusing on more natural phrasing and clearer technical communication.
Key changes:
- Simplified and shortened phrases for better readability (e.g., "npm dependencies" → "dependencies", "various higher-level tools" → "higher-level tools")
- Improved consistency in terminology (e.g., "dev server" throughout instead of "development server")
- Enhanced clarity in technical explanations (e.g., rephrasing comparisons and feature descriptions)
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/start/quick-start.mdx | Streamlined setup instructions and template descriptions for brevity |
| website/docs/en/guide/start/index.mdx | Improved phrasing in introduction, comparisons, and feature descriptions |
| website/docs/en/guide/faq/general.mdx | Minor grammar improvements for better flow |
| website/docs/en/guide/basic/html-template.mdx | Clarified template engine and configuration descriptions |
| website/docs/en/guide/advanced/browser-compatibility.mdx | Enhanced technical explanations for syntax and API compatibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Rewrote sentences in 5 English documentation files to sound more natural and professional without changing technical meaning.
Changes by file
Example change
All changes preserve original technical accuracy while improving readability for both native and non-native English speakers.
Original prompt
💡 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.