@modern-js/main-doc 2.58.2 → 2.59.0

package/docs/en/guides/concept/entries.mdx

@@ -16,7 +16,7 @@ Many configuration options provided by Modern.js are divided by entry, such as p
 
 ## Single Entry and Multiple Entries
 
-The project initialized by Modern.js is a single entry (SPA) project, with the following structure:
+The project initialized by Modern.js is a single entry project, with the following structure:
 
 ```
 .
@@ -56,13 +56,12 @@ After running the command, Modern.js will automatically generate a new entry dir
 
 The original entry code has been moved to a directory with the same name as the `name` field in `package.json`, and a `new-entry` entry directory has been created.
 
-You can run `pnpm run dev` to start the development server. At this point, you will see a new route named `/new-entry` added, and the existing page routes remain unchanged.
-
-:::tip
 Modern.js will use the entry with the same name as the `name` field in `package.json` as the main entry. The route of the main entry is `/`, and the route of other entries is `/{entryName}`.
 
-For example, when the `name` field in `package.json` is `myapp`, `src/myapp` will be the main entry of the project.
+You can run `pnpm run dev` to start the development server. At this point, you will see a new route named `/new-entry` added, and the existing page routes remain unchanged.
 
+:::note
+The concepts of **single entry/multiple entry** and **SPA/MPA** are not equivalent. The former pertains to how to configure and package the application, while the latter is about the patterns for organizing front-end applications. Each entry point can be either an SPA or a non-SPA.
 :::
 
 ## Entry Types
@@ -82,30 +81,26 @@ By default, Modern.js scans the files under `src/` before starting the project,
 
 :::
 
-Not all top-level directories under `src/` become project entries. The directory where the entry is located must meet one of the following five conditions:
+The entry directory must meet one of the following three conditions:
 
 1. Has a `routes/` directory.
 2. Has an `App.[jt]sx?` file.
-3. Has an `index.[jt]sx?` file.
-4. Has a `pages/` directory (compatible with Modern.js 1.0).
-5. Has an `entry.[jt]sx?` file.
+5. Has an `entry.[jt]sx?` file.(Requires [source.enableCustomEntry](/configure/app/source/enable-custom-entry) to be enabled)
 
-When the `src/` directory meets the entry requirements, Modern.js considers the current project as a single entry application.
+When the `src/` directory meets the conditions of an entry, Modern.js will consider the current application to be a single-entry application. Otherwise, Modern.js will scan the first-level directories under `src/` and further determine if they are entries. In this case, the application is typically a multi-entry application.
 
 :::tip
 In a single entry application, the default entry name is `main`.
 
 :::
 
-When the project is not a single entry application, Modern.js will further look at the top-level directories under `src/`.
-
 ### Framework Mode Entry
 
-The framework mode refers to the need to use the framework capabilities of Modern.js, such as nested routing, SSR, and integrated BFF, etc. Under this kind of entry convention, the entry defined by the developer is not the actual compilation entry. When Modern.js is launched, it generates a wrapped entry, and the real entry can be found at `node_modules/.modern/[entryName]/index.js`.
+Framework mode refers to using Modern.js's framework capabilities, such as convention routing, SSR (Server-Side Rendering), and integrated calls. Under this type of entry convention, the entries in the application are not the actual compilation entries. Modern.js will generate a wrapped entry during startup, which you can find in `node_modules/.modern/[entryName]/index.js`.
 
 #### Conventional Routing
 
-If there is a `routes/` directory in the entry, Modern.js will scan the files under `routes/` during startup, and automatically generate client-side routes (react-router) based on file conventions. For example:
+If there is a `routes/` directory within the entry, we refer to this entry as a convention-based route. Modern.js will scan the files under `routes/` during startup and automatically generate client-side routes (react-router) based on file conventions. For example:
 
 ```bash
 .
@@ -121,7 +116,19 @@ For more information, please refer to [Conventional Routing](/guides/basic-featu
 
 #### Self-controlled Routing
 
-If there is an `App.[jt]sx?` file in the entry, developers can set the client-side route in this file through code, or not set the client-side route.
+## Manual Routing
+
+If there is an `App.[jt]sx?` file within the entry, we refer to this entry as a self-controlled route. For example:
+
+```bash
+.
+├── src
+│   └── App.tsx
+```
+
+For entry points defined as `src/App.tsx`, Modern.js does not perform any additional routing operations. Developers can use the [React Router 6](https://reactrouter.com/en/main) API for development, define client-side routes or not to set any client-side routes.
+
+for example, define client-side routes in application:
 
 ```tsx
 import { BrowserRouter, Route, Routes } from '@modern-js/runtime/router';
@@ -138,16 +145,21 @@ export default () => {
 };
 ```
 
-For more information, please refer to [Self-controlled Routing](/guides/basic-features/routes.html#self-controlled-routing).
+:::note
+We recommend that developers use conventional routing. Modern.js provides a series of optimizations in resource loading and rendering for conventional routing by default and offers built-in SSR capabilities. When using manual routing, these capabilities need to be encapsulated by developers themselves.
+:::
 
-#### Custom Entry
 
-If there is an `entry.[jt]sx` file in the entry, developers need to call the `createRoot` and `render` functions in the `entry.[jt]sx` file to complete the project's entry logic.
+#### Custom Entry
 
 :::info
-Using this file requires enabling [source.enableCustomEntry](/configure/app/source/enable-custom-entry).
+Using this features requires enabling [source.enableCustomEntry](/configure/app/source/enable-custom-entry).
 :::
 
+By default, whether you use convention routing or self-controlled routing, Modern.js will automatically handle rendering. If you wish to customize this behavior, you can creating a custom entry file.
+
+If there is an `entry.[jt]sx` file within the entry, Modern.js will no longer control the application's rendering process. You can call the `createRoot` and `render` functions within the `entry.[jt]sx` file to complete the entry logic for your application.
+
 ```tsx
 import { createRoot } from '@modern-js/runtime/react';
 import { render } from '@modern-js/runtime/browser';
@@ -157,7 +169,9 @@ const ModernRoot = createRoot();
 render(<ModernRoot />);
 ```
 
-For example, if some other operations need to be performed before render is executed, it can be implemented in this way:
+In the code above, the component returned by the `createRoot` function is either the component generated from the `routes/` directory or the component exported by `App.tsx`. 
+
+The `render` function is used to handle rendering and mounting of the component. For example, if you want to execute some asynchronous tasks before rendering, you can achieve it like this:
 
 ```tsx
 import { createRoot } from '@modern-js/runtime/react';
@@ -166,7 +180,7 @@ import { render } from '@modern-js/runtime/browser';
 const ModernRoot = createRoot();
 
 async function beforeRender() {
-   // todo
+  // some async request
 }
 
 beforeRender().then(() => {
@@ -174,34 +188,15 @@ beforeRender().then(() => {
 });
 ```
 
-#### Custom Bootstrap
-
-:::warning
-Soon to be deprecated, it is recommended to use a custom entry.
-:::
-
-If there is an `index.[jt]sx` file in the entry, and the file exports a function by default, Modern.js will pass the default `bootstrap` function as a parameter and use the exported function to replace the default `bootstrap`. This way, developers can customize how components are mounted to DOM nodes or add custom behavior before mounting. For example:
-
-```tsx
-export default (App: React.ComponentType, bootstrap: () => void) => {
-  // do something before bootstrap...
-  initSomething().then(() => {
-    bootstrap();
-  });
-};
-```
-
 ### Build Mode Entry
 
-Build mode refers to not using the Runtime capabilities provided by Modern.js, but rather having the developer define the entry of the page completely on their own.
-
-When the entry directory contains `index.[jt]sx` (soon to be deprecated) and does not export a function via `export default`, or when there is an `entry.[jt]sx` file in the entry directory and the `@modern-js/runtime` dependency is not installed, the corresponding file will be identified as the entry module of webpack or Rspack.
-
 :::info
-Using the `entry.[jt]sx` file requires enabling [source.enableCustomEntry](/configure/app/source/enable-custom-entry).
+Using this features requires enabling [source.enableCustomEntry](/configure/app/source/enable-custom-entry).
 :::
 
-In this case, Modern.js will not generate the entry code automatically. Therefore, you need to manually mount the component to the DOM node, for example:
+Build mode refers to the development mode that does not use Modern.js's runtime capabilities and only utilizes Modern.js's build capabilities. When the `@modern-js/runtime` dependency is not installed in the application, Modern.js will treat all entries as build mode entries.
+
+In this case, if there is an `entry.[jt]sx` file within the entry, this file will be recognized as the build entry for webpack or Rspack. Modern.js will not automatically generate entry code at this time, and you need to mount the component to the DOM node yourself. For example:
 
 ```js title=src/entry.tsx
 import React from 'react';
@@ -211,9 +206,13 @@ import App from './App';
 ReactDOM.render(<App />, document.getElementById('root'));
 ```
 
-This approach is equivalent to enabling the [source.entries.disableMount](/configure/app/source/entries) option in Modern.js. When you use this approach, **you will not be able to use the runtime capabilities of the Modern.js framework**, such as the `runtime` configuration in the `modern.config.js` file will no longer take effect.
+In build mode, the application **will not be able to use Modern.js's runtime capabilities**, such as:
+- Convention routing, the routing based on the files under `src/routes`
+- Server-Side Rendering (SSR)
+- The `runtime` configuration in the `modern.config.js` file will no longer take effect
+
 
-## Custom Entries Config
+## Specify entry in the configuration file
 
 In some cases, you may need to customize the entry configuration instead of using the entry conventions provided by Modern.js.
 
@@ -246,4 +245,36 @@ export default defineConfig({
 });
 ```
 
-Note that when you enable `disableMount`, **you won't be able to use the runtime capabilities of the Modern.js framework**, such as the `runtime` configuration in the `modern.config.ts` file.
+It is worth noting that, by default, Modern.js considers entries specified through the configuration as **framework mode entries** and will automatically generate the actual compilation entry. 
+
+If your application is migrating from build tools like Webpack or Vite to the Modern.js framework, you typically need to enable the `disableMount` option in the entry configuration. In this case, Modern.js will treat the entry as a **build mode entry**.
+
+## Deprecated
+
+Currently, if the entry directory meets the following conditions, it will also be considered an application entry:
+
+1. Has an `index.[jt]sx?` file.
+2. Has a `pages/` directory.
+
+The `pages/` directory was the convention routing in older versions of Modern.js. Now, it is recommended to use the `routes/` directory.
+
+The `index.[jt]sx?` file supported **Custom Bootstrap** and **Build Mode Entry** in older versions. Now, it is recommended to use `entry.[jt]sx?` instead.
+
+### Custom Bootstrap
+
+When there is an `index.[jt]sx` file in the entry, and  the file's default export is a function, Modern.js will pass the default `bootstrap` function as an argument and use the exported function to replace the default `bootstrap`. 
+
+This allows developers to customize mounting components to DOM or add custom behaviors before mounting. For example:
+
+```tsx
+export default (App: React.ComponentType, bootstrap: () => void) => {
+  // do something before bootstrap...
+  initSomething().then(() => {
+    bootstrap();
+  });
+};
+```
+
+### Build Mode Entry
+
+When an `index.[jt]sx` file exists in the entry directory and does not export a function via export default, this entry will also be considered a build mode entry.

package/docs/en/guides/get-started/_meta.json

@@ -1,7 +1 @@
-[
-  "introduction",
-  "quick-start",
-  "upgrade",
-  "glossary",
-  "tech-stack"
-]
+["introduction", "quick-start", "upgrade", "glossary", "tech-stack"]

package/docs/en/guides/get-started/introduction.mdx

@@ -55,7 +55,7 @@ It mainly includes the following features:
 - 🏠 **Integration**: Development and production environment web server are unique, CSR and SSR are isomorphic development, and API service calls are functions as interfaces.
 - 📦 **Out Of The Box**: Default TS support, built-in build, ESLint, debugging tools, fully functional and testable.
 - 🌏 **Ecology**: Self-developed state management, micro-frontend, module packaging, and other peripheral needs.
-- 🕸 **Routing Modes**: Includes self-controlled routing, file-convention-based routing (nested routing), etc.
+- 🕸 **Convention Routing**: Using file-based routing helps developers quickly set up applications.
 
 ## Comparison with Others
 

package/docs/en/guides/get-started/quick-start.mdx

@@ -57,7 +57,7 @@ export default defineConfig({
     ssr: true,
   },
   plugins: [appTools({
-      bundler: 'webpack', // Set to 'experimental-rspack' to enable rspack ⚡️🦀
+      bundler: 'rspack', // Set to 'webpack' to enable webpack
   }),],
 });
 ```
@@ -72,7 +72,6 @@ In a newly created project, the `@modern-js/app-tools` npm package is installed
 - It integrates Modern.js Core, providing capabilities for configuration parsing, plugin loading, and more.
 - It integrates Modern.js Builder, providing build capabilities.
 - It integrates Modern.js Server, providing capabilities for development and production servers.
-- It integrates some commonly used plugins, such as `plugin-lint`, `plugin-data-loader`, and more.
 
 `@modern-js/app-tools` is implemented based on the plugin system of Modern.js. Essentially, it is a plugin. Therefore, you need to register `appTools` in the `plugins` field of the configuration file:
 

package/docs/en/guides/get-started/tech-stack.mdx

@@ -30,8 +30,6 @@ We are also working with Zack Jackson, the author of [Module Federation](https:/
 
 Modern.js can be used with any community state management library, such as [Redux](https://redux.js.org/), [Jotai](https://jotai.org/), [Zustand](https://docs.pmnd.rs/zustand), [Valtio](https://valtio.pmnd.rs/), and more.
 
-Modern.js also provides a wrapper around Redux called Reduck for state management. You can refer to ["Reduck State Management"](/en/guides/topic-detail/model/quick-start) for usage.
-
 ## Package Manager
 
 Modern.js can be used with any community package manager, such as [npm](https://www.npmjs.com/package/npm), [yarn](https://classic.yarnpkg.com/lang/en/), [pnpm](https://pnpm.io/), or [Bun](https://bun.sh/).
@@ -62,7 +60,7 @@ During production builds, Modern.js uses [Terser](https://github.com/terser/ters
 
 Modern.js uses [PostCSS](https://postcss.org/) to transform CSS code and enables [autoprefixer](https://github.com/postcss/autoprefixer) by default to add CSS prefixes.
 
-Modern.js supports enabling ["Tailwind CSS"](/en/guides/basic-features/css.html#using-tailwind-css) and is compatible with both Tailwind CSS v2 and v3.
+Modern.js supports enabling ["Tailwind CSS"](/guides/basic-features/css/tailwindcss) and is compatible with both Tailwind CSS v2 and v3.
 
 ## CSS Preprocessors
 
@@ -75,11 +73,11 @@ Modern.js supports three CSS preprocessors: [Sass](https://sass-lang.com/), [Les
 
 Modern.js provides out-of-the-box support for [CSS Modules](https://github.com/css-modules/css-modules), which is implemented internally based on [css-loader](https://www.npmjs.com/package/css-loader).
 
-Please refer to ["Use CSS Modules"](/guides/basic-features/css-modules) for usage instructions.
+Please refer to ["Use CSS Modules"](/guides/basic-features/css/css-modules) for usage instructions.
 
 ## CSS-in-JS
 
-Modern.js supports the use of [styled-components](https://styled-components.com/). Please refer to ["Using CSS-in-JS"](/en/guides/basic-features/css.html#using-css-in-js) for usage instructions.
+Modern.js supports the use of [styled-components](https://styled-components.com/). Please refer to ["Using CSS-in-JS"](/en/guides/basic-features/css/css-in-js) for usage instructions.
 
 If you need to use other CSS-in-JS solutions, you can integrate them into your project on your own.
 
@@ -91,7 +89,7 @@ Additionally, Modern.js provides built-in support for [on-demand import](/config
 
 ## Component Development
 
-Modern.js supports the use of [Storybook](https://storybook.js.org/) for developing UI components. This feature is optional. Please refer to ["Using Storybook"](/en/guides/advanced-features/using-storybook) to enable it.
+Modern.js supports the use of [Storybook](https://storybook.js.org/) for developing UI components. This feature is optional. Please refer to ["Using Storybook"](/guides/basic-features/debug/using-storybook) to enable it.
 
 ## Node.js Framework
 

package/docs/en/guides/get-started/upgrade.mdx

@@ -37,10 +37,24 @@ import ReleaseNote from '@site-docs-en/components/release-note';
 <ReleaseNote />
 
 :::tip
-When upgrading, you need to upgrade all packages provided by Modern.js, instead of upgrading a single dependency.
-
+When upgrading, you need to upgrade all packages provided by Modern.js, rather than upgrading some dependencies.
 :::
 
+## Version Management Strategy
+
+In Modern.js projects, we recommend that all officially provided dependencies use fixed version, and avoid using `^` or `~` for range declarations. For example:
+
+```json
+{
+  "dependencies": {
+    "@modern-js/app-tools": "x.y.z"
+  }
+}
+```
+
+This ensures that the versions of dependencies are fully determined, thereby guaranteeing build consistency and predictability.
+
+
 ## Lock nested dependency
 
 When a nested dependency of the project has a problem and Modern.js cannot be updated immediately, you can use the package manager to lock the version of the nested dependency.

package/docs/en/guides/topic-detail/framework-plugin/_meta.json

@@ -7,4 +7,4 @@
   "extend",
   "plugin-api",
   "hook-list"
-]
+]

package/docs/en/guides/topic-detail/generator/_meta.json

@@ -14,4 +14,4 @@
     "name": "plugin",
     "label": "generator-plugin"
   }
-]
+]

package/docs/en/guides/topic-detail/generator/create/_meta.json

@@ -1,5 +1 @@
-[
-  "use",
-  "option",
-  "config"
-]
+["use", "option", "config"]

package/docs/en/guides/topic-detail/generator/create/config.mdx

@@ -40,16 +40,6 @@ import PackageManager from '@site-docs-en/components/package-manager';
 
 <PackageManager />
 
-### buildTools
-
-Question: Please select the bundler.
-
-Options:
-
-- webpack -- webpack
-
-- Rspack -- rspack
-
 ## Npm Module
 
 ### packageName

package/docs/en/guides/topic-detail/generator/create/use.mdx

@@ -35,7 +35,6 @@ npx @modern-js/create@latest web-app
 ? Please select the type of project you want to create: Web App
 ? Please select the programming language: TS
 ? Please select the package manager: pnpm
-? Please select the bundler: webpack
 ```
 
 ### Create an Npm Module Project

package/docs/en/guides/topic-detail/generator/new/_meta.json

@@ -1,5 +1 @@
-[
-  "use",
-  "option",
-  "config"
-]
+["use", "option", "config"]

package/docs/en/guides/topic-detail/generator/plugin/_meta.json

@@ -8,4 +8,4 @@
     "name": "api",
     "label": "API"
   }
-]
+]

package/docs/en/guides/troubleshooting/_meta.json

@@ -1,6 +1 @@
-[
-  "dependencies",
-  "cli",
-  "builder",
-  "hmr"
-]
+["dependencies", "cli", "builder", "hmr"]

package/docs/en/tutorials/first-app/c03-css.mdx

@@ -294,7 +294,7 @@ A Utility Class named `custom-text-gray` is implemented in `src/routes/styles/ut
 ```
 
 :::info note
-Modern.js integrates with [PostCSS](/guides/basic-features/css) and supports modern CSS syntax features such as [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
+Modern.js integrates with [PostCSS](/guides/basic-features/css/css) and supports modern CSS syntax features such as [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
 
 :::
 

package/docs/zh/apis/app/runtime/core/use-loader.mdx

@@ -52,7 +52,7 @@ function useLoader(loaderFn: LoaderFn, options: Options): ReturnData;
   - `initialData`：首次执行前的初始数据，对应返回值中的 `data` 字段。
   - `skip`：当值为 `true` 时，函数不执行。
   - `params`：当 `params` 序列化结果发生改变时，函数会重新执行。同时，`params` 也会作为函数的第二个参数被传入。
-  - `static`：当值为 `true` 时，`useLoader` 用于 [SSG](/guides/advanced-features/ssg) 编译阶段数据的获取。
+  - `static`：当值为 `true` 时，`useLoader` 用于 [SSG](/guides/basic-features/render/ssg) 编译阶段数据的获取。
 
 ### 返回值
 

package/docs/zh/community/blog/_meta.json

@@ -1,6 +1 @@
-[
-  "overview",
-  "v2-release-note",
-  "2022-0910-updates",
-  "2022-0708-updates"
-]
+["overview", "v2-release-note", "2022-0910-updates", "2022-0708-updates"]

package/docs/zh/components/deploy.mdx

@@ -1 +1 @@
-本地验证完成后，可以将 `dist/` 下的产物整理成服务器需要的结构，进行部署。
+本地验证完成后，可以参考 [部署](/guides/basic-features/deploy.html) 一节，将项目部署到服务器上。

package/docs/zh/components/init-app.mdx

@@ -4,7 +4,6 @@
 ? 请选择你想创建的工程类型 Web 应用
 ? 请选择开发语言 TS
 ? 请选择包管理工具 pnpm
-? 请选择构建工具 webpack
 ```
 
 在生成项目后，Modern.js 会自动安装依赖、创建 git 仓库。

package/docs/zh/components/init-rspack-app.mdx

@@ -3,5 +3,4 @@ $ npx @modern-js/create@latest myapp
 ? 请选择你想创建的工程类型：Web 应用
 ? 请选择开发语言：TS
 ? 请选择包管理工具：pnpm
-? 请选择构建工具：Rspack
 ```

package/docs/zh/components/ssr-monitor.mdx

@@ -0,0 +1,3 @@
+:::note
+敬请期待
+:::

package/docs/zh/configure/_meta.json

@@ -75,4 +75,4 @@
   },
   "app/builder-plugins",
   "app/auto-load-plugin"
-]
+]