docs: improve English clarity in documentation#12060
Conversation
|
|
✅ Deploy Preview for rspack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation clarity and conciseness across multiple English documentation files by simplifying language, reducing wordiness, and making the content more direct and easier to understand.
- Rewrites sentences to be more concise and direct
- Converts passive voice to active voice where appropriate
- Simplifies complex sentence structures and removes redundant phrases
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/optimization/tree-shaking.mdx | Simplified explanations of tree shaking concepts, prerequisites, and configuration options |
| website/docs/en/config/experiments.mdx | Made experimental features descriptions more concise and direct |
| website/docs/en/config/cache.mdx | Streamlined cache configuration documentation |
| website/docs/en/api/runtime-api/hmr.mdx | Clarified HMR API descriptions and usage examples |
| website/docs/en/api/javascript-api/compiler.mdx | Improved clarity of Compiler API method descriptions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Rewrote unnatural English in 5 documentation files to sound more professional and native, following the pattern of high-quality open-source docs.
Changes
compiler.close()in the callback function ofcompiler.runand wait for it to finish. Only then can you proceed" → "Before starting a new compilation, callcompiler.close()in thecompiler.runcallback and wait for it to finish before callingcompiler.runagain")All changes preserve original meaning while improving readability for non-native English speakers. Spell check and formatting pass.
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.