docs: update migration guides for plugins#5598
Merged
chenjiahan merged 1 commit intomainfrom Jul 15, 2025
Merged
Conversation
✅ 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 adds a standalone migration guide for converting Vite plugins into Rsbuild plugins and updates existing documentation to reference it.
- Introduced a new
vite-plugin.mdxguide with a complete mapping of Vite/Rollup hooks to Rsbuild plugin APIs. - Updated both Chinese and English plugin dev index pages to link to the new migration guide.
- Removed inline hook tables from the original
vite.mdxguides in favor of the new dedicated guide. - Updated
_meta.jsonin both locales to includevite-pluginso the new guide appears in the migration sidebar.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| website/docs/zh/plugins/dev/index.mdx | Added “迁移 Vite 插件” section linking to the new migration guide. |
| website/docs/zh/guide/migration/vite.mdx | Replaced inline hook table with a reference link to the new guide. |
| website/docs/zh/guide/migration/vite-plugin.mdx | Added new Chinese migration guide for Vite plugins. |
| website/docs/zh/guide/migration/_meta.json | Added “vite-plugin” to the migration metadata array. |
| website/docs/en/plugins/dev/index.mdx | Added “Migrate Vite plugin” section linking to the new migration guide. |
| website/docs/en/guide/migration/vite.mdx | Replaced inline hook table with a reference link to the new guide. |
| website/docs/en/guide/migration/vite-plugin.mdx | Added new English migration guide for Vite plugins. |
| website/docs/en/guide/migration/_meta.json | Added “vite-plugin” to the migration metadata array. |
Comments suppressed due to low confidence (4)
website/docs/zh/guide/migration/vite-plugin.mdx:1
- [nitpick] The heading '# Vite 插件' does not clearly indicate migration context; consider renaming it to '迁移 Vite 插件' to align with link text in the index page and improve clarity.
# Vite 插件
website/docs/zh/guide/migration/vite.mdx:265
- [nitpick] Link text 'Vite 插件' is less specific than '迁移 Vite 插件'; consider updating the link text to '迁移 Vite 插件' for consistency with the section title.
参考 [Vite 插件](/guide/migration/vite-plugin) 了解如何迁移 Vite 插件。
website/docs/en/guide/migration/vite-plugin.mdx:1
- [nitpick] The heading '# Vite plugin' does not explicitly reflect that this is a migration guide; consider renaming it to 'Migrating Vite plugin' or 'Migrate Vite plugin' to match the navigation and improve clarity.
# Vite plugin
website/docs/en/guide/migration/vite.mdx:265
- [nitpick] The link text 'Vite plugin' is inconsistent with 'Migrate Vite plugin' used elsewhere; consider renaming the link to 'Migrate Vite plugin' for consistency.
See [Vite plugin](/guide/migration/vite-plugin) to learn how to migrate Vite plugins.
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
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
This pull request introduces a new section on migrating Vite plugins to Rsbuild plugins.
Checklist