docs: add migration guide for chunkSplit#7104
Conversation
Deploying rsbuild with
|
| Latest commit: |
a2245b2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3b776457.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://migrate-chunk-split-0201.rsbuild-v2.pages.dev |
Summary of ChangesHello @chenjiahan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the project's documentation to reflect a significant change in its chunk splitting configuration. It formally deprecates the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 438b099e1a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes the deprecated performance.chunkSplit documentation and adds a comprehensive migration guide to the v1-to-v2 upgrade document. The changes are well-structured and cover both English and Chinese documentation. I've provided a couple of suggestions to improve the accuracy and completeness of the new migration guide to ensure a smoother transition for all users.
There was a problem hiding this comment.
Pull request overview
This pull request adds migration documentation for the deprecated performance.chunkSplit configuration option and removes its dedicated documentation page. The performance.chunkSplit option is deprecated in Rsbuild 2.0 in favor of the new splitChunks configuration.
Changes:
- Added comprehensive migration guides in both English and Chinese upgrade documentation, explaining how to convert each
performance.chunkSplitstrategy to the newsplitChunksconfiguration - Removed the dedicated documentation pages for
performance.chunkSplit(both English and Chinese versions) - Added a redirect from the old documentation URL to the new
splitChunksconfiguration page - Updated references in code-splitting guides to remove the hyperlink to the deleted documentation page
- Reordered navigation items to place
splitChunksbeforeenvironmentsin the base configuration group
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/rspress.config.ts | Adds redirect from old /config/performance/chunk-split URL to new /config/split-chunks URL |
| website/theme/rsbuildPluginOverview.ts | Reorders navigation items, moving splitChunks before environments |
| website/docs/en/guide/upgrade/v1-to-v2.mdx | Adds migration guide section for performance.chunkSplit with examples for all strategies and forceSplitting |
| website/docs/zh/guide/upgrade/v1-to-v2.mdx | Chinese version of the migration guide section |
| website/docs/en/guide/optimization/code-splitting.mdx | Removes hyperlink from reference to performance.chunkSplit |
| website/docs/zh/guide/optimization/code-splitting.mdx | Chinese version of the reference update |
| website/docs/en/config/performance/chunk-split.mdx | Removes entire documentation page (194 lines deleted) |
| website/docs/zh/config/performance/chunk-split.mdx | Removes Chinese version of documentation page (194 lines deleted) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
Summary
performance.chunkSplitusage to the newsplitChunksconfigurationperformance.chunkSplitdocumentation, as this option is now deprecated.Checklist