doc: add rsbuild plugin start doc #5455
Draft
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. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new Chinese guide for developing Rsbuild plugins and updates navigation metadata.
- Introduces
start.mdxwith step-by-step plugin development instructions - Registers the plugin guide in both the plugin-specific and top-level guide
_meta.jsonfiles
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/guide/plugin/start.mdx | Added detailed Rsbuild plugin development guide |
| website/docs/zh/guide/plugin/_meta.json | Registered the start page in plugin metadata |
| website/docs/zh/guide/_meta.json | Added plugin directory entry to guide menu |
Comments suppressed due to low confidence (1)
website/docs/zh/guide/plugin/start.mdx:71
- 示例中应该使用
process.env.NODE_ENV而非process.node.NODE_ENV来判断环境。
1. 真实的 Rsbuild 实例会在 `modifyRsbuildConfig` `modifyEnvironmentConfig` `onBeforeStartDevServer` 之后创建，所以在这三个 API 内并没有明确的 mode 是 development 还是 production。在这三个 API 内可以通过 `process.node.NODE_ENV` 来判断是否为 development，在此之后的 API 中可以通过 hooks 参数中的 isDev isProd 来判断
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
adding the documents for developing a rsbuild plugin
Related Links
Checklist