docs: improve documentation authenticity and natural flow#6051
Merged
chenjiahan merged 4 commits intomainfrom Sep 4, 2025
Merged
docs: improve documentation authenticity and natural flow#6051chenjiahan merged 4 commits intomainfrom
chenjiahan merged 4 commits intomainfrom
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>
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Help me to improve the website/docs/en directory of the English document, many of the paragraphs are translated from Chinese, please find out these sentences are not authentic, without changing the original meaning of the case, replaced by more authent...
docs: improve English documentation authenticity and natural flow
Sep 3, 2025
chenjiahan
approved these changes
Sep 4, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the authenticity and natural flow of English documentation by replacing Chinese-to-English translation artifacts with more professional, native-sounding language commonly used in open-source projects.
- Replaced verbose constructions like "such as setting it to" with more concise alternatives
- Improved example introductions from "For example to set" to "To set, for example"
- Changed passive recommendations "it is recommended" to more engaging "we recommend"
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/en/guide/basic/html-template.mdx | Simplified example language from "such as setting the description" to "like a description" |
| website/docs/en/config/source/transform-import.mdx | Improved flow by changing "such as setting it to" to "for example setting it to" |
| website/docs/en/config/resolve/alias.mdx | Removed unnecessary article "the" from "use the source.alias" |
| website/docs/en/config/output/inline-scripts.mdx | Changed passive "it is recommended" to active "we recommend" |
| website/docs/en/config/output/asset-prefix.mdx | Multiple improvements including "use X to set" → "use X to configure" and example flow enhancements |
| website/docs/en/config/html/meta.mdx | Improved example introductions from "For example to set" to "To set, for example" |
| website/docs/en/config/dev/asset-prefix.mdx | Consistent improvements with output version, enhancing professional tone |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the English documentation in the
website/docs/endirectory by replacing non-authentic expressions with more natural, professional language commonly used in open-source project documentation.Changes Made
The improvements target common Chinese-to-English translation artifacts that make the documentation feel less authentic:
Pattern Improvements
"written to" → "placed in": Made file location descriptions more natural
Output files are written to the dist directory→Output files are placed in the dist directory"For example to set" → "To set, for example": Improved flow of examples
For example to set description:→To set a description, for example:"such as setting it to" → "such as" or "for example": Streamlined verbose constructions
such as setting it to a CDN URL→such as a CDN URLsuch as setting the description→like a description"you can use the X to set" → "use X to configure": More direct, professional tone
use the dev.assetPrefix to set→use dev.assetPrefix to configure"it is recommended" → "we recommend": More personal, engaging tone
it is recommended to set→we recommend settingFiles Modified
All changes preserve the original meaning while making the English more authentic and professional. The modifications follow the principle of making only noticeable improvements that enhance readability without altering technical content.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.