docs: update createRsbuild config parameter #6529
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
✅ 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 updates documentation to reflect the API change in Rsbuild 1.6 where the rsbuildConfig option in createRsbuild() has been renamed to config. The documentation updates span both English and Chinese versions, covering guides, API references, configuration docs, and release notes.
- Updated all code examples to use
configinstead ofrsbuildConfigwhen callingcreateRsbuild() - Added deprecation notices explaining that
configis the new option introduced in Rsbuild 1.6 - Updated TypeScript type definitions in documentation to reflect the new API signature
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/zh/guide/advanced/ssr.mdx | Updated SSR guide example to use config |
| website/docs/zh/guide/advanced/environments.mdx | Updated environments guide example to use config |
| website/docs/zh/config/server/middleware-mode.mdx | Updated middleware mode example to use config |
| website/docs/zh/community/releases/v0-5.mdx | Updated v0.5 release notes example to use config |
| website/docs/zh/api/javascript-api/instance.mdx | Updated instance API examples to use config |
| website/docs/zh/api/javascript-api/dev-server-api.mdx | Updated dev server API example to use config |
| website/docs/zh/api/javascript-api/core.mdx | Updated core API documentation with full explanation of new config option and deprecation notice |
| website/docs/en/guide/advanced/ssr.mdx | Updated English SSR guide example to use config |
| website/docs/en/guide/advanced/environments.mdx | Updated English environments guide example to use config |
| website/docs/en/config/server/middleware-mode.mdx | Updated English middleware mode example to use config |
| website/docs/en/community/releases/v0-5.mdx | Updated English v0.5 release notes example to use config |
| website/docs/en/api/javascript-api/instance.mdx | Updated English instance API examples to use config |
| website/docs/en/api/javascript-api/dev-server-api.mdx | Updated English dev server API example to use config |
| website/docs/en/api/javascript-api/core.mdx | Updated English core API documentation with full explanation of new config option and deprecation notice |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Update
createRsbuild's config parameter, the parameter name was changed to be more concise.Related Links
Checklist