feat: add deprecat function doc

web-infra-dev · Jun 25, 2024 · e2702ec · e2702ec
1 parent c5644c9
commit e2702ec
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/.changeset/wicked-shirts-rule.md b/.changeset/wicked-shirts-rule.md
@@ -0,0 +1,7 @@
+---
+'@modern-js/main-doc': patch
+---
+
+feat: add deprecat function doc
+
+feat: 添加下线功能文档
diff --git a/packages/document/main-doc/docs/en/guides/deprecat.md b/packages/document/main-doc/docs/en/guides/deprecat.md
@@ -0,0 +1,15 @@
+---
+sidebar_position: 10
+---
+
+# Deprecated Functions
+
+This article will introduce the functions that were previously supported by Modern.js, but have now been deprecated, along with the recommended alternatives.
+
+## Creating a Monorepo using @modern-js/create
+
+The Monorepo solution previously provided by Modern.js was implemented based on [pnpm Workspace](https://pnpm.io/workspaces) and did not offer substantial Monorepo management capabilities. In version [v2.53.0](https://github.com/web-infra-dev/modern.js/releases/tag/v2.53.0), the functionality to create Monorepo projects using `@modern-js/create` has been removed. It is recommended to directly use the Monorepo solutions provided by the community.
+
+## Enabling the test capability with the new command
+
+The test capability previously provided by Modern.js was a simple wrapper based on Jest, which led to issues such as unintuitive Jest configuration and more complex user configuration. In version [v2.53.0](https://github.com/web-infra-dev/modern.js/releases/tag/v2.53.0), the option to enable the test feature in application and module projects has been removed. It is recommended to directly use the testing solutions provided by the community.
diff --git a/packages/document/main-doc/docs/zh/guides/deprecat.md b/packages/document/main-doc/docs/zh/guides/deprecat.md
@@ -0,0 +1,15 @@
+---
+sidebar_position: 10
+---
+
+# 已下线功能
+
+本文将介绍 Modern.js 之前支持，但是现在已下线的功能及推荐替代方案。
+
+## 使用 @modern-js/create 创建 Monorepo
+
+Modern.js 之前提供的 Monorepo 方案是基于 [pnpm Workspace](https://pnpm.io/workspaces) 实现的，并未提供实质性的 Monorepo 管理能力。在 [v2.53.0](https://github.com/web-infra-dev/modern.js/releases/tag/v2.53.0) 版本中，移除了使用 `@modern-js/create` 创建 Monorepo 项目的功能。推荐直接使用社区提供的 Monorepo 方案。
+
+## new 命令开启 test 能力
+
+Modern.js 之前提供的测试能力是基于 Jest 的简单封装。该封装导致 Jest 配置不直观、用户配置更加复杂等问题。在 [v2.53.0](https://github.com/web-infra-dev/modern.js/releases/tag/v2.53.0) 版本中，移除了在应用项目和模块项目中开启 test 功能的选项。推荐直接使用社区提供的测试方案。