docs: add upgrade section#6891
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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 Rsbuild documentation by reorganizing and clarifying the upgrade and migration guides. It establishes a dedicated 'Upgrade' section, relocates relevant documents, and updates all associated links to enhance user experience and make it simpler for users to find information on upgrading their Rsbuild projects. 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.
Code Review
This pull request effectively reorganizes the documentation by separating 'upgrade' guides from 'migration' guides, which greatly improves clarity. The changes include moving files, updating navigation, and adjusting links, all of which have been done correctly. I've identified a couple of minor areas for improvement regarding terminology consistency and JSON file formatting for better maintainability. Overall, this is a great improvement to the documentation structure.
| "vite-plugin", | ||
| "modern-builder" | ||
| ] | ||
| ["webpack", "cra", "vue-cli", "vite", "vite-plugin", "modern-builder"] |
There was a problem hiding this comment.
While this single-line array is valid JSON, a multi-line format is generally more maintainable. It makes version control diffs cleaner when adding or removing items. Consider reverting to the multi-line format for better readability and easier future modifications.
| ["webpack", "cra", "vue-cli", "vite", "vite-plugin", "modern-builder"] | |
| [ | |
| "webpack", | |
| "cra", | |
| "vue-cli", | |
| "vite", | |
| "vite-plugin", | |
| "modern-builder" | |
| ] |
| @@ -1,4 +1,4 @@ | |||
| # Migrating from Rsbuild 0.x | |||
| # Upgrading from 0.x to v1 | |||
There was a problem hiding this comment.
The new title 'Upgrading from 0.x to v1' is much clearer. To maintain consistency with this change, consider updating the description on line 3. The term 'migration reference' could be changed to 'upgrade guide' to align with the new 'upgrade' terminology used throughout this PR.
| "vite-plugin", | ||
| "modern-builder" | ||
| ] | ||
| ["webpack", "cra", "vue-cli", "vite", "vite-plugin", "modern-builder"] |
There was a problem hiding this comment.
While this single-line array is valid JSON, a multi-line format is generally more maintainable. It makes version control diffs cleaner when adding or removing items. Consider reverting to the multi-line format for better readability and easier future modifications.
| ["webpack", "cra", "vue-cli", "vite", "vite-plugin", "modern-builder"] | |
| [ | |
| "webpack", | |
| "cra", | |
| "vue-cli", | |
| "vite", | |
| "vite-plugin", | |
| "modern-builder" | |
| ] |
| @@ -1,4 +1,4 @@ | |||
| # 从 Rsbuild 0.x 迁移 | |||
| # 从 0.x 升级到 v1 | |||
There was a problem hiding this comment.
The new title '从 0.x 升级到 v1' (Upgrading from 0.x to v1) is a good change. To maintain consistency, consider updating the description on line 3. The character '迁移' (migrate) could be changed to '升级' (upgrade) to align with the new terminology. For example, '你可以参考此文档来迁移' could become '你可以参考此文档来升级'.
There was a problem hiding this comment.
Pull request overview
This PR reorganizes Rsbuild's documentation by separating upgrade guides from migration guides into distinct sections, improving navigation and clarity for users looking to upgrade versus migrate from other tools.
Key Changes:
- Creates a new "upgrade" section in the documentation with its own navigation entry
- Moves upgrade-related content from the "basic" section to the new "upgrade" section
- Renames the v0-to-v1 migration guide to clarify it's about upgrading between Rsbuild versions
- Updates all internal documentation links to reflect the new structure
Reviewed changes
Copilot reviewed 15 out of 16 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
website/docs/{en,zh}/guide/upgrade/v0-to-v1.mdx |
Updated title to emphasize upgrading between Rsbuild versions rather than general migration |
website/docs/{en,zh}/guide/upgrade/upgrade-rsbuild.mdx |
Moved from basic section; English title updated to use gerund form "Upgrading" |
website/docs/{en,zh}/guide/upgrade/_meta.json |
New metadata file defining page order in the upgrade section |
website/docs/{en,zh}/guide/optimization/build-performance.mdx |
Updated internal link to point to new upgrade section location |
website/docs/{en,zh}/guide/migration/_meta.json |
Removed v0-to-v1 entry as it moved to upgrade section |
website/docs/{en,zh}/guide/basic/_meta.json |
Removed upgrade-rsbuild entry as it moved to upgrade section |
website/docs/{en,zh}/guide/_meta.json |
Added new "upgrade" section header between optimization and migration sections |
website/docs/{en,zh}/community/releases/v1-0.mdx |
Updated internal link to v0-to-v1 guide in new location |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Reorganizes and improves the Rsbuild upgrade and migration documentation, separate upgrade guides from migration guides, clarify navigation, and update all relevant links and section headers.
Checklist