docs: add zephyr to docs page #6071
Merged
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 documentation for Zephyr Cloud deployment integration to the Rsbuild project, introducing Zephyr as a zero-config deployment platform option for Rsbuild applications.
- Adds comprehensive documentation for Zephyr Cloud deployment with setup instructions and configuration examples
- Includes a dedicated section in the main README promoting Zephyr Cloud integration
- Registers the new documentation in the deployment guide navigation
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| website/docs/en/guide/deployment/zephyr-cloud.mdx | New comprehensive documentation file covering Zephyr Cloud deployment setup, configuration examples, and integration details |
| website/docs/en/guide/deployment/_meta.json | Registers the new Zephyr Cloud documentation in the deployment guide navigation |
| README.md | Adds promotional section for Zephyr Cloud with logo reference and feature highlights |
Nsttt
force-pushed
the
feat/zephyr
branch
2 times, most recently
from
5e232c9 to
e92f1fb
Compare
Nsttt
changed the title
chenjiahan
reviewed
Sep 8, 2025
Comment on lines
89
to
131
| 1. Install the Zephyr plugin for Rsbuild: | ||
|
|
||
| ```bash | ||
| npm install zephyr-rsbuild-plugin --save-dev | ||
| ``` | ||
|
|
||
| 2. Add the plugin to your Rsbuild configuration: | ||
|
|
||
| ```ts title="rsbuild.config.ts" | ||
| import { defineConfig } from '@rsbuild/core'; | ||
| import { pluginReact } from '@rsbuild/plugin-react'; | ||
| import { withZephyr } from 'zephyr-rsbuild-plugin'; | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [pluginReact(), withZephyr()], | ||
| }); | ||
| ``` | ||
|
|
||
| or with Module Federation | ||
|
|
||
| ```ts title="rsbuild.config.ts" | ||
| import { defineConfig } from '@rsbuild/core'; | ||
| import { pluginReact } from '@rsbuild/plugin-react'; | ||
| import { pluginModuleFederation } from '@module-federation/rsbuild-plugin'; | ||
| import { withZephyr } from 'zephyr-rsbuild-plugin'; | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [ | ||
| pluginReact(), | ||
| pluginModuleFederation({ | ||
| name: 'my-app', | ||
| remotes: { | ||
| 'shared-ui': 'shared_ui@http://localhost:3001/remoteEntry.js', | ||
| }, | ||
| shared: { | ||
| react: { singleton: true }, | ||
| 'react-dom': { singleton: true }, | ||
| }, | ||
| }), | ||
| withZephyr(), // Add after Module Federation | ||
| ], | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
Could we link this part to the README of zephyr-rsbuild-plugin? This allows users to see up-to-date documentation
|
@Nsttt Could you update this PR to align with web-infra-dev/rspress#2555? Thank you! |
|
Added @chenjiahan |
Merged
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 PR adds Zephyr to the docs page.
Related Links
Checklist