docs: improve env and target contexts #5478
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for environment and target contexts by refining descriptions and examples in both Chinese and English docs, and by adding detailed JSDoc comments to the ModifyChainUtils type.
- Updates explanatory texts for development and production build conditions.
- Refines target environment descriptions with practical configuration examples.
- Enhances the ModifyChainUtils type documentation with additional properties and detailed comments.
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/zh/config/tools/rspack.mdx | Clarified boolean descriptions and target configuration examples. |
| website/docs/zh/config/tools/bundler-chain.mdx | Updated documentation with example code but introduced a method name change. |
| website/docs/en/config/tools/rspack.mdx | Enhanced descriptions and examples in English. |
| website/docs/en/config/tools/bundler-chain.mdx | Updated explanatory texts with a potential method name change. |
| packages/core/src/types/hooks.ts | Added detailed JSDoc comments to the ModifyChainUtils type. |
Comments suppressed due to low confidence (2)
website/docs/zh/config/tools/bundler-chain.mdx:101
- The method name was changed from 'bundlerChain' to 'rspack' in this documentation. Please verify that this change aligns with the actual API and update any inconsistent references if needed.
rspack: (config, { target }) => {
website/docs/en/config/tools/bundler-chain.mdx:101
- The method name was changed from 'bundlerChain' to 'rspack' in this documentation. Please verify that this change reflects the intended API usage and update related references accordingly.
rspack: (config, { target }) => {
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
This pull request introduces enhancements to the
ModifyChainUtilstype and updates related documentation. The changes add new JSDoc to the type and refine the documentation for clarity and consistency.Checklist