docs: update terminology and clarify compilation scope#5341
Merged
chenjiahan merged 3 commits intomainfrom Jun 1, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refines terminology around “降级”/“downgrade” to “编译范围”/“Compilation scope” and updates examples to illustrate the new object-based include filter syntax.
- Renamed section headings and list labels for clarity in both Chinese and English docs.
- Clarified default SWC transformation scope and rationale.
- Replaced simplistic
path.resolveexamples with an advanced filter object to excludenode_modules.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/guide/advanced/browser-compatibility.mdx | Updated headings, lists, and clarified default SWC scope; added filter example using { and: […], not: … } |
| website/docs/zh/config/source/include.mdx | Adjusted heading terminology for monorepo modules |
| website/docs/en/guide/advanced/browser-compatibility.mdx | Mirrored terminology and example updates in English |
| website/docs/en/config/source/include.mdx | Updated heading and terminology for monorepo modules |
Comments suppressed due to low confidence (4)
website/docs/en/guide/advanced/browser-compatibility.mdx:145
- [nitpick] Lowercase
makeafter the comma or split into two sentences for correct grammar: e.g.,..., and make Rsbuild perform extra compilation for this dependency.
When you find that a third-party dependency causes compatibility issues, you can add this dependency to Rsbuild's [source.include](/config/source/include) config, Make Rsbuild do extra compilation for this dependency.
website/docs/en/config/source/include.mdx:94
- [nitpick] Heading uses “libraries” but the text refers to “modules”—consider using a single term (e.g., “modules”) for consistency.
## Compile libraries in monorepo
website/docs/zh/guide/advanced/browser-compatibility.mdx:178
- Consider adding a brief note explaining this object-based include filter syntax (
andwithnot) so readers understand how it excludesnode_modules.
{ and: [packagesDir, { not: /[\\/]node_modules[\\/]/ }], }
website/docs/en/guide/advanced/browser-compatibility.mdx:178
- Add a short explanation of the
{ and: […], not: … }filter syntax to help readers unfamiliar with this advanced include pattern.
{ and: [packagesDir, { not: /[\\/]node_modules[\\/]/ }], }
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.
Summary
Reorganized sections to focus on "Compilation scope" instead of "Downgrade method," providing clearer explanations for Rsbuild's categorization and rationale.
Checklist