docs: add Modern.js Builder upgrade tip (#5029)

web-infra-dev · Dec 1, 2023 · 57fe18a · 57fe18a
1 parent e2c899b
commit 57fe18a
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 0 deletions.
diff --git a/packages/document/builder-doc/docs/en/guide/features.mdx b/packages/document/builder-doc/docs/en/guide/features.mdx
@@ -1,5 +1,13 @@
 # All Features
 
+:::tip Notice
+Modern.js Builder has been rebranded as Rsbuild. This document will no longer be updated.
+
+- If you are using the Modern.js framework, please visit the [Modern.js framework documentation](https://modernjs.dev/) directly.
+- If you are using the CLI or Node API of Modern.js Builder, you can easily migrate to Rsbuild, please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.
+
+:::
+
 Here are all the main features supported by Modern.js Builder.
 
 ## JavaScript

diff --git a/packages/document/builder-doc/docs/en/guide/glossary.mdx b/packages/document/builder-doc/docs/en/guide/glossary.mdx
@@ -1,5 +1,13 @@
 # Glossary
 
+:::tip Notice
+Modern.js Builder has been rebranded as Rsbuild. This document will no longer be updated.
+
+- If you are using the Modern.js framework, please visit the [Modern.js framework documentation](https://modernjs.dev/) directly.
+- If you are using the CLI or Node API of Modern.js Builder, you can easily migrate to Rsbuild, please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.
+
+:::
+
 ## Bundler
 
 import Bundler from '@en/shared/bundler.md';

diff --git a/packages/document/builder-doc/docs/en/guide/introduction.mdx b/packages/document/builder-doc/docs/en/guide/introduction.mdx
@@ -1,5 +1,13 @@
 # Introduction
 
+:::tip Notice
+Modern.js Builder has been rebranded as Rsbuild. This document will no longer be updated.
+
+- If you are using the Modern.js framework, please visit the [Modern.js framework documentation](https://modernjs.dev/) directly.
+- If you are using the CLI or Node API of Modern.js Builder, you can easily migrate to Rsbuild, please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.
+
+:::
+
 Modern.js Builder is **a Build Engine for web development**.
 
 With the growing of the front-end ecosystem, more and more build tools and plugins are created. For most developers, the configuration and dependencies required to build a web application have become complex; the cost of finding best practices for developers has also risen.
@@ -107,3 +115,4 @@ import Step from '@components/Step';
     description="View detailed API documentation"
   />
 </NextSteps>
+```
diff --git a/packages/document/builder-doc/docs/en/guide/quick-start.mdx b/packages/document/builder-doc/docs/en/guide/quick-start.mdx
@@ -1,5 +1,13 @@
 # Quick Start
 
+:::tip Notice
+Modern.js Builder has been rebranded as Rsbuild. This document will no longer be updated.
+
+- If you are using the Modern.js framework, please visit the [Modern.js framework documentation](https://modernjs.dev/) directly.
+- If you are using the CLI or Node API of Modern.js Builder, you can easily migrate to Rsbuild, please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information.
+
+:::
+
 ## Environment preparation
 
 import NodeVersion from '@en/shared/nodeVersion.md';

diff --git a/packages/document/builder-doc/docs/zh/guide/features.mdx b/packages/document/builder-doc/docs/zh/guide/features.mdx
@@ -1,5 +1,13 @@
 # 功能导航
 
+:::tip 注意事项
+Modern.js Builder 已升级为 Rsbuild 独立品牌，当前文档将不再继续迭代。
+
+- 如果你在使用 Modern.js 框架，请直接访问 [Modern.js 框架文档](https://modernjs.dev/)。
+- 如果你在使用 Modern.js Builder 的 CLI 或 Node API，可以轻松迁移到 Rsbuild，请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多。
+
+:::
+
 在这里，你可以了解到 Modern.js Builder 支持的主要功能。
 
 ## JavaScript 编译

diff --git a/packages/document/builder-doc/docs/zh/guide/glossary.mdx b/packages/document/builder-doc/docs/zh/guide/glossary.mdx
@@ -1,5 +1,13 @@
 # 名词解释
 
+:::tip 注意事项
+Modern.js Builder 已升级为 Rsbuild 独立品牌，当前文档将不再继续迭代。
+
+- 如果你在使用 Modern.js 框架，请直接访问 [Modern.js 框架文档](https://modernjs.dev/)。
+- 如果你在使用 Modern.js Builder 的 CLI 或 Node API，可以轻松迁移到 Rsbuild，请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多。
+
+:::
+
 ## Bundler
 
 import Bundler from '@zh/shared/bundler.md';

diff --git a/packages/document/builder-doc/docs/zh/guide/introduction.mdx b/packages/document/builder-doc/docs/zh/guide/introduction.mdx
@@ -1,5 +1,13 @@
 # 介绍
 
+:::tip 注意事项
+Modern.js Builder 已升级为 Rsbuild 独立品牌，当前文档将不再继续迭代。
+
+- 如果你在使用 Modern.js 框架，请直接访问 [Modern.js 框架文档](https://modernjs.dev/)。
+- 如果你在使用 Modern.js Builder 的 CLI 或 Node API，可以轻松迁移到 Rsbuild，请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多。
+
+:::
+
 Modern.js Builder 是**一个基于 Rspack 的 Web 构建工具**。
 
 随着前端生态的发展，社区中出现了多样化的编译工具和插件。对于大部分开发者来说，构建一个 Web 应用所需的配置和依赖已变得十分复杂。在追求最佳实践的过程中，开发者需要付出的成本也在不断上升。

diff --git a/packages/document/builder-doc/docs/zh/guide/quick-start.mdx b/packages/document/builder-doc/docs/zh/guide/quick-start.mdx
@@ -1,5 +1,13 @@
 # 快速上手
 
+:::tip 注意事项
+Modern.js Builder 已升级为 Rsbuild 独立品牌，当前文档将不再继续迭代。
+
+- 如果你在使用 Modern.js 框架，请直接访问 [Modern.js 框架文档](https://modernjs.dev/)。
+- 如果你在使用 Modern.js Builder 的 CLI 或 Node API，可以轻松迁移到 Rsbuild，请访问 [Rsbuild 仓库](https://github.com/web-infra-dev/rsbuild) 了解更多。
+
+:::
+
 ## 环境准备
 
 import NodeVersion from '@zh/shared/nodeVersion.md';