docs: update splitChunks documentation to add usage examples#7097
docs: update splitChunks documentation to add usage examples#7097chenjiahan merged 2 commits intomainfrom
Conversation
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 significantly improves the documentation for Rsbuild's 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
|
There was a problem hiding this comment.
Pull request overview
This PR refines the Rsbuild splitChunks documentation in both Chinese and English, improving clarity about its relationship to Rspack's optimization.splitChunks and adding a concrete configuration example. The changes reorganize explanatory text and add a tip explaining how presets are merged with user configuration.
Changes:
- Clarified that Rsbuild's
splitChunksbuilds on Rspack'soptimization.splitChunkswith direct links to the relevant Rspack docs. - Added a practical
rsbuild.config.tsexample showing howpresetcoexists with standard RspacksplitChunksoptions. - Introduced a dedicated section describing non-
presetoptions and a tip explaining the deep-merge behavior and priority of user-defined configuration.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/config/split-chunks.mdx | Refines Chinese splitChunks docs, adds an example config and tip on how presets are merged with user options, and links to Rspack’s optimization.splitChunks docs. |
| website/docs/en/config/split-chunks.mdx | Mirrors the Chinese updates in English, clarifying API layering, adding an example config, and documenting merge behavior and option compatibility with Rspack. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Code Review
This pull request improves the documentation for splitChunks by restructuring the content for better clarity and adding a helpful usage example. The changes make it easier to understand how Rsbuild's splitChunks presets work with Rspack's options. My review includes suggestions to fix broken links in the documentation to ensure users can access the referenced Rspack documentation.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ae70b139c8
ℹ️ 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".
Deploying rsbuild with
|
| Latest commit: |
ae70b13
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cf1b48e7.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://split-chunks-doc-0131.rsbuild-v2.pages.dev |
Summary
Updated the explanation of how Rsbuild's
splitChunksbuilds on top of Rspack'soptimization.splitChunks, now using clearer language and direct links to the Rspack documentation.Checklist