docs: clarify runtime-tools dependency in module federation docs#7487
docs: clarify runtime-tools dependency in module federation docs#7487chenjiahan merged 5 commits intomainfrom
Conversation
Deploying rsbuild with
|
| Latest commit: |
ab5d137
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://46d6fb07.rsbuild-v2.pages.dev |
| Branch Preview URL: | https://chenjiahan-docs-runtime-tool.rsbuild-v2.pages.dev |
There was a problem hiding this comment.
Pull request overview
Updates Rsbuild documentation to clarify that using moduleFederation.options (Module Federation v1.5) requires installing @module-federation/runtime-tools, and adds the same upgrade note to the v1→v2 migration guides in both English and Chinese.
Changes:
- Add an upgrade note in the v1→v2 migration guides (EN/ZH) about installing
@module-federation/runtime-toolswhen usingmoduleFederation.options. - Update the
moduleFederation.optionsconfig docs (EN/ZH) to document the runtime dependency and show an install command. - Restructure the migration guide dependency section to separate Polyfill vs Module Federation notes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| website/docs/zh/guide/upgrade/v1-to-v2.mdx | Adds Module Federation runtime-tools installation note in the v1→v2 migration guide (ZH). |
| website/docs/zh/config/module-federation/options.mdx | Documents the runtime-tools requirement for moduleFederation.options and adds install snippet (ZH). |
| website/docs/en/guide/upgrade/v1-to-v2.mdx | Adds Module Federation runtime-tools installation note and restructures dependency section (EN). |
| website/docs/en/config/module-federation/options.mdx | Documents the runtime-tools requirement for moduleFederation.options and adds install snippet (EN). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Rsbuild v2 documentation to reflect that @module-federation/runtime-tools is now an optional peer dependency, requiring manual installation for projects using Module Federation v1.5. The review feedback focuses on improving documentation quality by ensuring consistent linking to external resources—specifically adding anchor tags to Rspack documentation and linking package names to npm—and standardizing technical terminology in the Chinese translation.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
@module-federation/runtime-toolsmust be installed when usingmoduleFederation.optionsRelated Links