From f68d365fc32b4eb2f69e0d75bcd650badfe25637 Mon Sep 17 00:00:00 2001 From: Zack Jackson <25274700+ScriptedAlchemy@users.noreply.github.com> Date: Wed, 13 Aug 2025 13:46:42 -0700 Subject: [PATCH] docs: refresh advanced api overview --- advanced-api/README.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/advanced-api/README.md b/advanced-api/README.md index d23cc09a9b4..8ce5e1c4ce3 100644 --- a/advanced-api/README.md +++ b/advanced-api/README.md @@ -1,8 +1,27 @@ # Advanced API -This leverages pre-release implementations of Webpack 5 Module Federation's new advanced API +Examples in this directory showcase early implementations of advanced Module Federation features. Each subfolder is a standalone example with its own documentation. -There are several configurations in here +## Available examples -- Dynamic Remotes - - The ability to dynamically load and share code between remotes that are unknown to the host at build time. +- [Automatic Vendor Sharing](./automatic-vendor-sharing/README.md) – automatically detect and share common dependencies across federated builds. +- [Dynamic Remotes](./dynamic-remotes/README.md) – dynamically load and share code from remotes that aren't known to the host at build time. +- [Dynamic Remotes with Runtime Environment Variables](./dynamic-remotes-runtime-environment-variables/README.md) – configure remote URLs via runtime-provided environment variables and container-friendly setups. +- [Dynamic Remotes with Synchronous Imports](./dynamic-remotes-synchronous-imports/README.md) – change remote URLs at runtime while keeping static import syntax like `import Widget from 'app2/Widget'`. + +## Getting started + +Install dependencies at the repository root: + +```bash +pnpm install +``` + +Then run or build any example from its folder, e.g.: + +```bash +pnpm --filter automatic-vendor-sharing_* start +pnpm --filter dynamic-remotes_* build +``` + +See each example's README for detailed instructions.