Merge branch 'main' into fix/metro-windows-path-comparisons

Author: ryok90

.changeset/docs-improve.md

@@ -0,0 +1,13 @@
+---
+'website-new': patch
+'@module-federation/rspress-plugin': patch
+---
+
+docs: improve guides, configuration, and integrations content
+
+- Unify internal links to absolute `/path/to/page.html` form (drop relative paths and `/zh` / `/en` prefixes).
+- Restructure configuration option pages for consistent formatting.
+- Refresh integration guides for Modern.js, Next.js, Angular, Vue, and React.
+- Reorganize runtime API and hooks reference, and rewrite advanced/start/data guides.
+- Sync all updates between EN and ZH locales.
+- Bump `@rspress/shared` runtime dep and `@rspress/core` peer to `2.0.14`.

apps/website-new/README.md

@@ -1,44 +1,63 @@
 # website-new
 
-This is the example application for Module Federation core.
+This is a website built with Rspress and Webpack 5 Module Federation, serving as a playground for testing and demonstrating the capabilities of Module Federation in a real-world application.
 
-## Usage
-
-Run the development server and navigate to the provided localhost URL.
+## Scripts
 
-## Troubleshooting
+- `pnpm dev`: Start dev server
+- `pnpm build`: Build production bundle
 
-Clear `.nx` cache if you encounter unexpected build issues.
+## Configuration
 
-## Build
+Check `rspress.config.ts` for federation settings.
 
-Output will be located in the `dist` or `.next` folder.
+## Authoring docs: where to put reusable mdx
 
-## Scripts
+The docs site has two kinds of reusable mdx pieces. Pick the right bucket so links keep working under both `/en` and `/zh`.
 
-- `pnpm start`: Start dev server
-- `pnpm build`: Build production bundle
-
-## Configuration
+```
+docs/
+  _snippets/                # shared, language-agnostic code snippets
+    install-kit.mdx
+    rspack/create-config.mdx
+    node/*.mdx
+    ...
+  en/
+    _components/            # English-only doc fragments
+      runtime/index.mdx
+      secondary-build.mdx
+      ...
+  zh/
+    _components/            # Chinese-only doc fragments
+      runtime/index.mdx
+      ...
+```
 
-Check `webpack.config.js` or `next.config.js` for federation settings.
+**Use `docs/_snippets/` when the file is:**
 
-## Description
+- A pure code/command snippet (bash output, ts/js config example)
+- Reusable across languages with no prose
+- Possibly parameterized via `props` (e.g. `install-kit.mdx` uses `${props.pkgName}`)
 
-This package demonstrates a specific use case of Module Federation within the ecosystem.
+**Use `docs/<lang>/_components/` when the file contains:**
 
-## Features
+- Localized prose / explanatory text
+- Cross-page markdown links like `/guide/...` — these must live under `docs/<lang>/` so rspress prefixes them with the correct locale, otherwise the zh site will jump to en pages
 
-- Remote loading
-- Shared dependencies
-- Type safety
+### Import aliases
 
----
+`rspress.config.ts` provides:
 
-_Optimized by Aiden_
+- `@components` → `src/components/` — real React components (`.tsx`)
+- `@docs` → `docs/` — used to import the mdx partials above
 
-## Installation
+Examples:
 
-```bash
-pnpm install
+```mdx
+import Collapse from '@components/Collapse'; // tsx component
+import InstallKit from '@docs/_snippets/install-kit'; // shared snippet
+import Runtime from '@docs/zh/_components/runtime/index'; // zh fragment
+import Runtime from '@docs/en/_components/runtime/index'; // en fragment
 ```
+
+Both `_snippets/` and `_components/` are excluded from routing by rspress's default `excludeConvention` (`**/_[^_]*`), so they never produce a public page.