@modern-js/module-tools-docs 2.45.0 → 2.46.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @modern-js/module-tools-docs
 
+## 2.46.1
+
+## 2.46.0
+
 ## 2.45.0
 
 ## 2.44.0

package/docs/en/api/config/build-config.mdx

@@ -134,14 +134,17 @@ export default () => <Logo />;
 
 :::
 
-When enabled, the type of svg used can be modified by adding a type definition to the `modern-app-env.d.ts` file:
+When enabled, the type of svg used can be modified by initing a new declaration file and adding to the `modern-app-env.d.ts`:
 
-```ts title="modern-app-env.d.ts"
+```ts title="your-app-env.d.ts"
 declare module '*.svg' {
   const src: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
   export default src;
 }
+```
 
+```ts title="modern-app-env.d.ts"
+/// <reference path='./your-app-env.d.ts' />
 /// <reference types='@modern-js/module-tools/types' />
 ```
 

package/docs/en/guide/advance/in-depth-about-build.md

@@ -244,9 +244,12 @@ With `buildType: 'bundleless'`, type files are generated using the project's `ts
 
 The **Modern.js Module also supports bundling of type files**, although care needs to be taken when using this feature.
 
+- Bundle type files does not enable type checking.
 - Some third-party dependencies have incorrect syntax that can cause the bundling process to fail. So in this case, you need to exclude such third-party packages manually with [`buildConfig.externals`](/en/api/config/build-config#externals) or close [dts.respectExternal](/api/config/build-config#dtsrespectexternal) to external all third-party packages types.
 - It is not possible to handle the case where the type file of a third-party dependency points to a `.ts` file. For example, the `package.json` of a third-party dependency contains something like this: `{"types": ". /src/index.ts"}`.
 
+For the above problems, our recommended approach is to first use `tsc` to generate d.ts files, then package the index.d.ts as the entry and close `dts.respectExternal`. In the future evolution, we will gradually move towards this handling approach.
+
 ### Alias Conversion
 
 During the bundleless build process, if an alias appears in the source code, e.g.

package/docs/en/guide/basic/before-getting-started.md

@@ -6,7 +6,7 @@ sidebar_position: 1
 
 ## Environment preparation
 
-In order to use the Modern.js Module, you first need [NodeJS](https://nodejs.org/zh/) engine, we recommend the latest [LTS version](https://github.com/nodejs/Release), and make sure the Node version is **>=14.18.0**. because non-stable NodeJS releases frequently have bugs. You might consider installing via [nvm-windows](https://github.com/coreybutler/nvm-windows) and [nvm](https://github.com/nvm-sh/nvm) (Mac / Linux), so you can easily switch to different NodeJS versions that might be required for different projects that you work on.
+In order to use the Modern.js Module, you first need [NodeJS](https://nodejs.org/zh/) engine, we recommend the latest [LTS version](https://github.com/nodejs/Release), and make sure the Node version is **>=16.0.0**. because non-stable NodeJS releases frequently have bugs. You might consider installing via [nvm-windows](https://github.com/coreybutler/nvm-windows) and [nvm](https://github.com/nvm-sh/nvm) (Mac / Linux), so you can easily switch to different NodeJS versions that might be required for different projects that you work on.
 
 ## Getting Started with npm
 

package/docs/en/guide/basic/command-preview.md

@@ -14,7 +14,7 @@ Usage: modern build [options]
 Build module command
 
 Options:
-  -w, --watch Build code in listening mode
+  -w, --watch Enable watch mode to listen for changes on the fs and automatically rebuild
   --tsconfig [tsconfig] Specify the path to the tsconfig.json file (default:
                          ". /tsconfig.json")
   --platform [platform] Build artifacts for all or specified platforms
@@ -24,18 +24,7 @@ Options:
   -h, --help Show information about the current command
 ```
 
-When you want to start a project build, you can execute the `modern build` command. When using this command, we can:
-
-- When wanting to start a build in watch mode, use the `--watch` option.
-- When you want to specify the path to the TypeScript configuration file read by the project build, use `-build --tsconfig . /path/config.json` option. This option overrides all [`buildConfig`](/api/config/build-config) configurations in [`dts.tsconfigPath`](/api/config/build-config).
-- The `-no-dts` option can be used when the DTS type file generation and type checking behavior of the project needs to be turned off. **Note: The generation of type files depends on the results of type checking. If type checking is turned off, then type files will not be generated either**.
-- The `--no-clear` option can be used when the automatic clearing of the output directory needs to be turned off.
-
-In addition to the above, Modern.js Module also support `platform` build mode, which can be used to perform build tasks for other tools. For example if you are using module doc plugin, it is currently officially supported to start a doc build task to generate html artifacts by executing the `modern build --platform` or `modern build --platform doc` commands after installing the `@modern-js/plugin-module-doc` plugin.
-
-:::tip
-When executing a doc build, if you need to read the build artifacts of the project. Then **don't forget to execute the `modern build` command to ensure the existence of the project's build artifacts before executing the `modern build --platform` command to start the doc build**.
-:::
+Modern.js Module supports the `platform` build mode, which can be used to execute build tasks of other tools. Currently, the official support includes [Rspress](https://rspress.dev/). For example, you can start the doc build task to generate doc products by executing the `modern build --platform` commands.
 
 ## `modern new`
 

package/docs/en/guide/basic/use-micro-generator.md

@@ -17,6 +17,7 @@ The microgenerator can be started via [`modern new`](/guide/basic/command-previe
 ## Develop Module Doc
 
 When we want to write documentation for out module project, we can enable the module doc feature. **will create `docs` directory and related files in the project directory, and add `"@modern-js/plugin-rspress"` dependency** in package.json.
+Use `modern dev` and `modern build --platform` to debug and build your doc site.
 
 :::tip
 After successfully enabling it, you will be prompted to manually add a code similar to the one below to the configuration.
@@ -35,6 +36,7 @@ export default defineConfig({
 ## Test
 
 When we want to test some modules, we can enable the test feature. When this feature is enabled, **a `tests` directory and related files will be created in the project directory, and a new `"@modern-js/plugin-testing"` dependency will be added to package.json**.
+Use `edenx test` to run tests.
 
 :::tip
 After successfully enabling it, you will be prompted to manually add a code similar to the one below to the configuration.
@@ -52,7 +54,7 @@ export default defineConfig({
 
 ## Storybook
 
-The **Storybook feature** can be enabled when we want to debug a component or a common module. When this feature is enabled, **the `stories` directory and `.storybook` directory are created in the project directory, and a new `"@modern-js/storybook"` dependency is added to package.json**.
+The **Storybook feature** can be enabled when we want to debug a component or a common module. When this feature is enabled, **the `stories` directory and `.storybook` directory are created in the project directory, and a new `"@modern-js/storybook"` dependency is added to package.json**. Use `storybook dev` and `storybook build` to debug and build.
 
 ## Tailwind CSS Support
 

package/docs/en/guide/basic/use-module-doc.mdx

@@ -403,19 +403,23 @@ type ParseToolOptions = {
 
 In case of `web`, the component will be rendered directly in the page, otherwise it will be loaded through an iframe.
 
-### desperated: languages
+### deprecated: languages
 
 :::warning
 Starting from version MAJOR_VERSION.44.0, please refer to the [Internationalization](https://rspress.dev/guide/default-theme/i18n.html) section to implement multiple languages.
 :::
 
-### desperated: useModuleSidebar
+### deprecated: useModuleSidebar
 
 :::warning
 Starting from version MAJOR_VERSION.44.0, a sniffing mechanism has been implemented internally, so please directly use [\_meta.json](https://rspress.dev/guide/basic/auto-nav-sidebar.html)
 or directly configure [sidebar](https://rspress.dev/api/config/config-theme.html#sidebar) to implement a custom sidebar.
 :::
 
+## Scripts
+- `modern dev`: Start dev server for doc site.
+- `modern build --platform`: Build doc site in production, by default output directories is `doc_build`.
+
 ## Advanced guide
 
 The above has covered the basics of developing module documentation, but this is not enough for developing a complete documentation station. Check out the [Rspress](https://rspress.dev) for an in-depth look at our documentation framework.

package/docs/en/guide/basic/using-storybook.mdx

@@ -165,6 +165,17 @@ Start Storybook,[detail](https://storybook.js.org/docs/react/api/cli-options#dev
 
 Build Storybook for production,[detail](https://storybook.js.org/docs/react/api/cli-options#build)
 
+## Migrate from V6 to V7
+
+Our support methods for the two versions are different, so if you are migrating from V6 to V7,
+we hope you will also use V7 in the same way, while making the following adjustments:
+
+- Configuration file: Migrate any custom configurations (if any) in the original `root/config/storybook/main.(j|t)s` to the new `root/.storybook/main.(j|t)s`.
+- Dependencies: Upgrade `@storybook/addon-*` series dependencies (if any) to version 7 and delete `@modern-js/plugin-storybook` dependencies.
+- Commands: Delete the original `edenx dev storybook` and `edenx build --platform` commands.
+  If you are used to the original `pnpm run dev` usage, you can replace it with `storybook dev -p 6006` and `storybook build`.
+- modern.config.(j|t)s : Remove the registration of `@modern-js/plugin-storybook` plugin.
+
 ## V6 (legacy)
 
 Starting from `MAJOR_VERSION.40.0` version, `@modern-js/plugin-storybook` will stop iterating. It is recommended to use the V7 version.

package/docs/en/guide/faq/basic.mdx

@@ -0,0 +1,13 @@
+# General Questions
+
+## What is the relationship between Modern.js Module and Rsbuild?
+
+Modern.js Module uses esbuild to build toolkits and component libraries, and Rsbuild focuses on solving web application building scenarios.
+
+## Can Modern.js Module use webpack plugins or loaders?
+
+Modern.js Module is based on esbuild for building and cannot use tools from the webpack-related ecosystem.
+You can find more community plugins for esbuild [here](https://github.com/esbuild/community-plugins)
+
+If the UMD product produced by Modern.js Module does not meet your requirements, you can use Rsbuild and add [UMD Plugin](https://rsbuild.dev/plugins/list/plugin-umd) to build UMD products.
+

package/docs/en/guide/faq/build.mdx

@@ -1,5 +1,10 @@
 # Build FAQ
 
+Here only some common problems and bad cases are recorded.
+
+**If the build products do not meet expectations, especially when [buildPreset](/api/config/build-preset) is configured,
+please first understand what configuration items buildPreset represents, and then check each configuration item based on all configuration items.**
+
 ## Product FAQ
 
 import BuildProductFAQ from '@site-docs-en/components/faq-build-product';
@@ -200,13 +205,22 @@ module.exports = {
 };
 ```
 
-### Bundle DTS failed
+### Bundleless DTS failed
 
-Normally, the type file output with `tsc` is loose. Modern.js Module not only supports outputting loose type file artifacts, but also supports packing type files, which allows you to package these loose type files and third-party dependent type files into one file.
+In the bundleless scenario, it's `tsc` that generates the type declaration file directly. You can find the problem file by printing the error message in the terminal.
+For source code files, it is recommended to fix the type problem, which can better enable reuse of your package. However. if you encounter a type checking problem with a thrid-party package:
 
-However, there is a risk in packaging the type files of third-party dependencies, **because there are cases where the type files of third-party dependencies cannot be packaged**.
+1. enable [skipLibCheck](https://www.typescriptlang.org/tsconfig#skipLibCheck) to skip the d.ts check of the thrid-party package.
+2. If the package exports ts files directly, skipLibCheck will not work because it can only skip the d.ts check,
+so you can only turn off [dts.abortOnError](/api/config/build-config.html#dtsabortonerror) to ignore these errors.
+
+### Bundle DTS failed
 
-So when you encounter a `Bundle DTS failed` error message during the Modern.js Module build, you can observe that the error message comes from a third-party dependency. Try setting [`dts.respectExternal`](/api/config/build-config.html#dtsrespectexternal) to `false` to disable the behavior of packing type files of third-party dependencies.
+The Modern.js Module directly uses [rollup-plugin-dts](https://github.com/Swatinem/rollup-plugin-dts) to package your type description files.
+**It may not be able to handle the type files of some third-party dependencies**
+
+If you encounter an error message titled "Bundle DTS failed" during the build process of the Modern.js Module, you can observe that the error message is from a third-party dependency.
+Try setting [`dts.respectExternal`](/api/config/build-config.html#dtsrespectexternal) to `false` to turn off the behavior of packaging type files of third-party dependencies.
 
 ### Error reported for `defineConfig` function type: `If there is no reference to "..." then the inferred type of "default" cannot be named`
 
@@ -218,13 +232,6 @@ Check if the [`include`](https://www.typescriptlang.org/tsconfig#include) config
 }
 ```
 
-### Bundleless DTS failed
-
-In the bundleless scenario, it's `tsc` that generates the type declaration file directly. You can find the problem file by printing the error message in the terminal. For source code files, it is recommended to fix the type problem, which can better enable reuse of your package. However. if you encounter a type checking problem with a thrid-party package:
-
-1. enable [skipLibCheck](https://www.typescriptlang.org/tsconfig#skipLibCheck) to skip the d.ts check of the thrid-party package.
-2. If the package exports ts files directly, skipLibCheck will not work because it can only skip the d.ts check, so you can only turn off [dts.abortOnError](/api/config/build-config.html#dtsabortonerror) to ignore these errors.
-
 ## Other FAQ
 
 import BuildOtherFAQ from '@site-docs-en/components/faq-build-other';

package/docs/en/guide/faq/index.md

@@ -2,6 +2,7 @@
 
 Here is a list of all frequently asked questions about Modern.js Module.
 
+- [General FAQ](./basic.mdx)
 - [Build FAQ](./build.mdx)
-- [Test FAQ](./test.mdx)
 - [Storybook FAQ](./storybook.mdx)
+- [Test FAQ](./test.mdx)

package/docs/en/guide/intro/getting-started.mdx

@@ -6,7 +6,7 @@ sidebar_position: 3
 
 ## 3 minute demo
 
-Want to experience Modern.js Module in action? The only prerequisite you need is [Node.js LTS](https://github.com/nodejs/Release) and make sure your Node version is **>= 14.18.0**.We recommend using the LTS version of Node.js 18.
+Want to experience Modern.js Module in action? The only prerequisite you need is [Node.js LTS](https://github.com/nodejs/Release) and make sure your Node version is **>= 16.0.0**.We recommend using the LTS version of Node.js 18.
 
 ### Create new project
 

package/docs/en/plugins/official-list/plugin-import.mdx

@@ -81,11 +81,10 @@ export default defineConfig({
 
 [SWC](https://swc.rs/) (Speedy Web Compiler) is written in Rust, and this plugin is based on SWC and ported from [babel-plugin-import](https://github.com/umijs/babel-plugin-import). The configuration options remain consistent.
 
-Some configurations can accept functions, such as `customName`, `customStyleName`, etc. These JavaScript functions are called by Rust through Node-API, which can cause some performance degradation.
+Some configurations can be passed in as functions, such as `customName`, `customStyleName`, etc., but in Modern.js Module, we do not recommend using functions in these configuration items.
+Because we will call SWC in the esbuild plugin, and then when Rust calls these configuration functions through Node-API, a deadlock will occur.
 
-Simple function logic can be replaced by template language. Therefore, for configurations such as `customName`, `customStyleName`, etc., instead of passing functions, you can also pass a string as a template to replace the function, improving performance.
-
-We will use the following code as example:
+Simple function logic can actually be replaced by template language. Below is an example of using a template with `customName`:
 
 ```ts
 import { MyButton as Btn } from 'foo';

package/docs/zh/api/config/build-config.mdx

@@ -132,14 +132,17 @@ import Logo from './logo.svg';
 export default () => <Logo />;
 ```
 
-当开启功能后，可以通过在 `modern-app-env.d.ts` 文件中增加类型定义，修改使用 SVG 的类型：
+当开启功能后，可以新建一个类型描述文件，并在 `modern-app-env.d.ts` 文件中增加，修改使用 SVG 的类型：
 
-```ts title="modern-app-env.d.ts"
+```ts title="your-app-env.d.ts"
 declare module '*.svg' {
   const src: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
   export default src;
 }
+```
 
+```ts title="modern-app-env.d.ts"
+/// <reference path='./your-app-env.d.ts' />
 /// <reference types='@modern-js/module-tools/types' />
 ```
 

package/docs/zh/guide/advance/in-depth-about-build.md

@@ -244,8 +244,11 @@ export default defineConfig({
 
 **Modern.js Module 同时还支持对类型文件进行打包**，不过使用该功能的时候需要注意：
 
+- 对类型文件进行打包不会开启类型检查。
 - 一些第三方依赖存在错误的语法会导致打包过程失败。因此对于这种情况，需要手动通过 [`buildConfig.externals`](/api/config/build-config#externals) 将这类第三方包排除，或者直接关闭[dts.respectExternal](/api/config/build-config#dtsrespectexternal)从而不打包任何三方包类型。
-- 对于第三方依赖的类型文件指向的是一个 `.ts` 文件的情况，目前无法处理。比如第三方依赖的 `package.json` 中存在这样的内容： `{"types": "./src/index.ts"}`。
+- 对于第三方依赖的类型文件指向的是一个 `.ts` 文件的情况，目前无法处理。比如第三方依赖的 `package.json` 中存在这样的内容： `{"types": "./src/index.ts"`。
+
+对于上述问题，我们推荐的处理方式是首先使用 `tsc` 生成 d.ts 文件，然后将 index.d.ts 作为入口进行打包处理，并且关闭 `dts.respectExternal`。在之后的演进我们也会逐渐向这种处理方式靠拢。
 
 ### 别名转换
 

package/docs/zh/guide/basic/before-getting-started.md

@@ -6,7 +6,7 @@ sidebar_position: 1
 
 ## 环境准备
 
-为了使用 Modern.js Module，首先需要 [NodeJS](https://nodejs.org/zh/)，我们推荐最新的[长期维护版本](https://github.com/nodejs/Release)，并确保 Node 版本大于等于 **14.18.0**。因为非稳定的 NodeJS 时常有一些 Bug，你可以使用 [nvm-windows](https://github.com/coreybutler/nvm-windows) 和 [nvm](https://github.com/nvm-sh/nvm)（Mac / Linux）安装，这样你就可以方便地切换到不同的 NodeJS 版本，这些版本可能会用于不同的项目。
+为了使用 Modern.js Module，首先需要 [NodeJS](https://nodejs.org/zh/)，我们推荐最新的[长期维护版本](https://github.com/nodejs/Release)，并确保 Node 版本大于等于 **16.0.0**。因为非稳定的 NodeJS 时常有一些 Bug，你可以使用 [nvm-windows](https://github.com/coreybutler/nvm-windows) 和 [nvm](https://github.com/nvm-sh/nvm)（Mac / Linux）安装，这样你就可以方便地切换到不同的 NodeJS 版本，这些版本可能会用于不同的项目。
 
 ## 初识 npm
 

package/docs/zh/guide/basic/command-preview.md

@@ -24,18 +24,7 @@ Options:
   -h, --help             展示当前命令的信息
 ```
 
-当想要启动项目构建的时候，可以执行 `modern build` 命令。在使用这个命令的时候，我们可以：
-
-- 当想要以观察模式启动构建时，使用 `--watch` 选项。
-- 当想要指定项目编译读取的 TypeScript 配置文件的路径时，使用 `build --tsconfig ./path/config.json` 选项。使用该选项后，会覆盖所有 [`buildConfig`](/api/config/build-config) 里 [`dts.tsconfigPath`](/api/config/build-config) 配置。
-- 当需要关闭项目的 DTS 类型文件生成和类型检查行为时，可以使用 `--no-dts` 选项。**注意：类型文件的生成依赖类型检查的结果。如果关闭了类型检查，那么类型文件也不会生成**。
-- 当需要关闭自动清除产物输出目录的行为时，可以使用 `--no-clear` 选项。
-
-除了以上方式，Modern.js Module 还支持 `platform` 构建模式，可以用于执行其他工具的构建任务。例如，若使用 doc 插件，官方支持在安装了 `@modern-js/plugin-module-doc` 插件后，可以通过执行 `modern build --platform` 或者 `modern build --platform doc` 命令启动 doc 构建任务生成 doc 产物。
-
-:::tip
-在执行 doc 构建的时候，如果需要读取项目的构建产物。那么**在执行 `modern build --platform` 命令启动 doc 构建之前，不要忘记先执行 `modern build` 命令确保项目构建产物的存在**。
-:::
+Modern.js Module 支持 `platform` 构建模式，可以用于执行其他工具的构建任务，目前官方支持的有 [Rspress](https://rspress.dev/)。例如，可以通过执行 `modern build --platform` 命令启动 doc 构建任务生成 doc 产物。
 
 ## `modern new`
 

package/docs/zh/guide/basic/use-micro-generator.md

@@ -17,6 +17,7 @@ Modern.js Module 提供了微生成器工具，它可以为当前项目：
 ## 开发模块文档
 
 当我们想要为模块编写文档的时候，可以启用模块文档功能。**会在项目目录下创建 `docs` 目录以及相关文件，在 package.json 中新增 `"@modern-js/plugin-rspress"` 依赖**。
+使用 `modern dev` 和 `modern build --platform` 来调试和构建你的文档站点。
 
 :::tip
 在成功开启后，会提示需要手动在配置中增加如下类似的代码。
@@ -34,7 +35,7 @@ export default defineConfig({
 
 ## Test 测试
 
-当我们想要对一些模块进行测试的时候，可以启用测试功能。启动该功能后，**会在项目目录下创建 `tests` 目录以及相关文件，在 package.json 中新增 `"@modern-js/plugin-testing"` 依赖**。
+当我们想要对一些模块进行测试的时候，可以启用测试功能。启动该功能后，**会在项目目录下创建 `tests` 目录以及相关文件，在 package.json 中新增 `"@modern-js/plugin-testing"` 依赖**。使用 `modern test` 来测试你的模块。
 
 :::tip
 在成功开启后，会提示需要手动在配置中增加如下类似的代码。
@@ -52,7 +53,7 @@ export default defineConfig({
 
 ## Storybook 调试
 
-当我们想要对组件或者普通模块进行调试的时候，可以启用 Storybook 调试功能。启动该功能后，**会在项目目录下创建 `stories` 目录以及 `.storybook` 目录，在 package.json 中新增 `"@modern-js/storybook"` 依赖**。
+当我们想要对组件或者普通模块进行调试的时候，可以启用 Storybook 调试功能。启动该功能后，**会在项目目录下创建 `stories` 目录以及 `.storybook` 目录，在 package.json 中新增 `"@modern-js/storybook"` 依赖**。使用 `storybook dev` 和 `storybook build` 来调试和构建。
 
 ## Tailwind CSS 支持
 

package/docs/zh/guide/basic/use-module-doc.mdx

@@ -399,19 +399,23 @@ type ParseToolOptions = {
 
 `web`时，代码块内容将会直接渲染在页面中，反之将会通过 iframe 加载。
 
-### desperated: languages
+### deprecated: languages
 
 :::warning
 从 MAJOR_VERSION.44.0 版本开始，请参考 [国际化](https://rspress.dev/zh/guide/default-theme/i18n.html) 章节来实现多语言。
 :::
 
-### desperated: useModuleSidebar
+### deprecated: useModuleSidebar
 
 :::warning
 从 MAJOR_VERSION.44.0 版本开始，内部实现了嗅探机制，请直接使用 [_meta.json](https://rspress.dev/zh/guide/basic/auto-nav-sidebar.html)
 或者直接配置 [sidebar](https://rspress.dev/zh/api/config/config-theme.html#sidebar) 来实现自定义侧边栏。
 :::
 
+## 命令行
+- `modern dev`: 启动文档站本地开发。
+- `modern build --platform`: 构建生产环境产物。
+
 ## 进阶指南
 
 以上已经介绍完了开发模块文档的基本内容，但是这对于开发一个完整的文档站是不够的。查看[Rspress](https://rspress.dev)以深入了解我们的文档框架。

package/docs/zh/guide/basic/using-storybook.mdx

@@ -178,6 +178,16 @@ const config = defineConfig({
 export default config;
 ```
 
+## 从 V6 迁移至 V7
+
+我们对于两个版本的支持方式不同，因此如果你是从 V6 迁移至 V7 的用户，我们希望你也按上述方式使用 V7，同时做以下调整:
+
+- 配置文件：将原来 `root/config/storybook/main.(j|t)s` 里的自定义配置（如果有）迁移到新的 `root/.storybook/main.(j|t)s`。
+- 依赖：升级 `@storybook/addon-*` 系列依赖（如果有）到 7 版本，并删除 `@modern-js/plugin-storybook` 依赖。
+- 命令: 将原来 `edenx dev storybook` 和 `edenx build --platform` 命令删除，如果习惯了原来的 `pnpm run dev` 的调用方式，可以
+  将其替换成 `storybook dev -p 6006` 和 `storybook build`。
+- modern.config.(j|t)s : 删除 `@modern-js/plugin-storybook` 插件的注册。
+
 ## V6 (legacy)
 
 从 `MAJOR_VERSION.40.0` 版本开始，`@modern-js/plugin-storybook`将停止迭代。建议使用 V7 版本。

package/docs/zh/guide/faq/basic.mdx

@@ -0,0 +1,12 @@
+# 通用类问题
+
+## Modern.js Module 和 Rsbuild 的关系？
+
+Modern.js Module 使用 esbuild 构建工具库和组件库，Rsbuild 专注于解决 Web 应用构建场景。
+
+## Modern.js Module 是否可以使用 webpack plugin 或者 loader?
+
+Modern.js Module 基于 esbuild 构建，无法使用 webpack 相关生态的工具。
+[这里](https://github.com/esbuild/community-plugins)可以发现更多 esbuild 社区插件
+
+如果 Modern.js Module 生产的 UMD 产物达不到你的要求，可以使用 Rsbuild 并添加 [UMD Plugin](https://rsbuild.dev/zh/plugins/list/plugin-umd) 构建 UMD 产物。

package/docs/zh/guide/faq/build.mdx

@@ -1,5 +1,10 @@
 # 构建相关问题
 
+这里只记录了一些常见问题和 bad case。
+
+**如果是构建产物不符合预期的场景，尤其是配置了 [buildPreset](/api/config/build-preset) 的情况下，
+请先了解 buildPreset 代表了哪些配置项，再根据所有的配置项逐个检查**
+
 ## 产物问题
 
 import BuildProductFAQ from '@site-docs/components/faq-build-product';
@@ -193,20 +198,26 @@ module.exports = {
                 return options;
               });
           },
-        }
-      }
-    }
+        },
+      },
+    },
   },
 };
 ```
 
-### Bundle DTS failed
+### Bundleless DTS failed
+
+在不打包的场景下，是直接 `tsc` 生成类型声明文件。通过终端打印的错误信息，你可以找到问题文件。对于源码文件，推荐将类型问题进行修复，这能够更好地使你的包得到复用。但如果遇到三方包的类型检查问题：
 
-正常情况下，使用 `tsc` Modern.js Module 不仅支持输出松散的类型文件产物，同时也支持打包类型文件，可以将这些松散的类型文件以及第三方依赖的类型文件打包成一个文件。
+1. 开启 [skipLibCheck](https://www.typescriptlang.org/tsconfig#skipLibCheck) 来跳过三方包的 d.ts 检查。
+2. 如果三方包直接导出 ts 文件， skipLibCheck 将会失效，因为其只能跳过 d.ts 检查，因此你只能关闭 [dts.abortOnError](/api/config/build-config.html#dtsabortonerror) 来忽略这些错误。
+
+### Bundle DTS failed
 
-不过，打包第三方依赖的类型文件是存在风险的，**因为存在第三方依赖的类型文件无法打包的情况**。
+Modern.js Module 直接使用 [rollup-plugin-dts](https://github.com/Swatinem/rollup-plugin-dts) 来打包你的类型描述文件。
+**它可能无法处理某些第三方依赖的类型文件**。
 
-因此当遇到 Modern.js Module 构建过程中出现 `Bundle DTS failed` 的错误信息标题的时候，可以观察报错信息是来自某个第三方依赖。尝试设置 [`dts.respectExternal`](/api/config/build-config.html#dtsrespectexternal) 为 `false` 来关闭打包第三方依赖的类型文件的行为。
+如果遇到 Modern.js Module 构建过程中出现 `Bundle DTS failed` 的错误信息标题的时候，可以观察报错信息是来自某个第三方依赖。尝试设置 [`dts.respectExternal`](/api/config/build-config.html#dtsrespectexternal) 为 `false` 来关闭打包第三方依赖的类型文件的行为。
 
 ### `defineConfig` 函数类型报错：`如果没有引用 "..."，则无法命名 "default" 的推断类型`
 
@@ -218,13 +229,6 @@ module.exports = {
 }
 ```
 
-### Bundleless DTS failed
-
-在不打包的场景下，是直接 `tsc` 生成类型声明文件。通过终端打印的错误信息，你可以找到问题文件。对于源码文件，推荐将类型问题进行修复，这能够更好地使你的包得到复用。但如果遇到三方包的类型检查问题：
-
-1. 开启 [skipLibCheck](https://www.typescriptlang.org/tsconfig#skipLibCheck) 来跳过三方包的 d.ts 检查。
-2. 如果三方包直接导出 ts 文件， skipLibCheck 将会失效，因为其只能跳过 d.ts 检查，因此你只能关闭[dts.abortOnError](/api/config/build-config.html#dtsabortonerror)来忽略这些错误。
-
 ## 其他
 
 import BuildOtherFAQ from '@site-docs/components/faq-build-other';

package/docs/zh/guide/faq/index.md

@@ -2,6 +2,7 @@
 
 这里是 Modern.js Module 常见问题分类列表：
 
-- [代码构建相关的问题](./build.mdx)
-- [测试相关的问题](./test.mdx)
-- [Storybook 相关的问题](./storybook.mdx)
+- [通用类问题](./basic.mdx)
+- [构建相关问题](./build.mdx)
+- [Storybook 相关问题](./storybook.mdx)
+- [测试相关问题](./test.mdx)

package/docs/zh/guide/intro/getting-started.mdx

@@ -6,7 +6,7 @@ sidebar_position: 3
 
 ## 三分钟快速上手
 
-想要实际体验 Modern.js Module？首先你需要安装 [Node.js LTS](https://github.com/nodejs/Release)，并确保 Node 版本大于等于 **14.18.0**。我们推荐使用 Node.js 18 的 LTS 版本。
+想要实际体验 Modern.js Module？首先你需要安装 [Node.js LTS](https://github.com/nodejs/Release)，并确保 Node 版本大于等于 **16.0.0**。我们推荐使用 Node.js 18 的 LTS 版本。
 
 ### 创建新项目
 

package/docs/zh/plugins/official-list/plugin-import.mdx

@@ -82,11 +82,10 @@ export default defineConfig({
 
 [SWC](https://swc.rs/) (Speedy Web Compiler) 是基于 Rust 语言编写的，而该插件是基于 SWC，移植自 [babel-plugin-import](https://github.com/umijs/babel-plugin-import)，配置选项保持了一致。
 
-一些配置可以传入函数，例如 `customName`，`customStyleName` 等，这些 JavaScript 函数会由 Rust 通过 Node-API 调用，这种调用会造成一些性能劣化。
+一些配置可以传入函数，例如 `customName`，`customStyleName` 等， 但在 Modern.js Module 里，我们不建议在此配置项里使用函数。
+因为我们会在 esbuild 的插件里调用 SWC，然后再当 Rust 通过 Node-API 调用这些配置函数时，会出现死锁现象。
 
-简单的函数逻辑其实可以通过模版语言来代替，因此 `customName`，`customStyleName` 等这些配置除了可以传入函数，也可以传入字符串作为模版来代替函数，提高性能。
-
-我们以这段代码作为示例：
+简单的函数逻辑其实可以通过模版语言来代替，下面是一个 `customName` 使用模板的示例：
 
 ```ts
 import { MyButton as Btn } from 'foo';
@@ -111,7 +110,7 @@ modulePluginImport({
 import Btn from 'foo/es/MyButton';
 ```
 
-可以看出配置 `customName: "foo/es/{{ member }}"` 的效果等同于配置 `` customName: (member) => `foo/es/${member}`  `` ，但是不会有 Node-API 的调用开销。
+可以看出配置 `customName: "foo/es/{{ member }}"` 的效果等同于配置 `` customName: (member) => `foo/es/${member}`  `` 。
 
 这里使用到的模版是 [handlebars](https://handlebarsjs.com)，模版配置中还内置了一些有用的辅助工具，还是以上面的导入语句为例，配置成：
 

package/package.json

@@ -9,14 +9,14 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.45.0",
+  "version": "2.46.1",
   "main": "index.js",
   "devDependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rspress": "1.8.4",
-    "@rspress/shared": "1.8.4",
-    "@modern-js/doc-plugin-auto-sidebar": "2.45.0"
+    "rspress": "1.10.0",
+    "@rspress/shared": "1.10.0",
+    "@modern-js/doc-plugin-auto-sidebar": "2.46.1"
   },
   "scripts": {
     "dev": "rspress dev",