docs: adjust configure Rsbuild document (#1209)

web-infra-dev · Jan 8, 2024 · 7f1c16e · 7f1c16e
1 parent 7b907c8
commit 7f1c16e
Show file tree

Hide file tree

Showing 14 changed files with 18 additions and 14 deletions.
diff --git a/packages/document/docs/en/config/index.mdx b/packages/document/docs/en/config/index.mdx
@@ -1,5 +1,7 @@
 # Config Overview
 
+This page lists all the configurations for Rsbuild. See ["Configure Rsbuild"](/guide/basic/configure-rsbuild) for detail.
+
 import Overview from '@components/Overview';
 
 <Overview />
diff --git a/packages/document/docs/en/config/tools/bundler-chain.mdx b/packages/document/docs/en/config/tools/bundler-chain.mdx
@@ -219,4 +219,4 @@ For example, the `RULE.STYLUS` rule exists only when the Stylus plugin is regist
 
 ### Examples
 
-For usage examples, please refer to: [BundlerChain examples](/guide/basic/configure-rspack#examples).
+For usage examples, please refer to: [BundlerChain examples](/guide/basic/configure-rsbuild#examples).
diff --git a/packages/document/docs/en/guide/basic/_meta.json b/packages/document/docs/en/guide/basic/_meta.json
@@ -1,13 +1,13 @@
 [
   "cli",
-  "config",
   "server",
   "output-files",
   "css-usage",
   "static-assets",
   "json-files",
   "wasm-assets",
   "configure-rspack",
+  "configure-rsbuild",
   "html-template",
   "css-modules",
   "typescript",

diff --git a/...s/document/docs/en/guide/basic/config.mdx → ...docs/en/guide/basic/configure-rsbuild.mdx b/...s/document/docs/en/guide/basic/config.mdx → ...docs/en/guide/basic/configure-rsbuild.mdx
@@ -1,4 +1,4 @@
-# Config
+# Configure Rsbuild
 
 Rsbuild provides a wide range of configuration options and sets a common default value for each option, which can meet the requirements of most use cases. Therefore, in most cases, you don't need to declare any Rsbuild configurations and can use it out of the box.
 
@@ -16,7 +16,7 @@ Rsbuild Configs are divided into the following categories:
 - Output: Config related to output.
 - Performance: Config related to performance.
 
-You can find detailed descriptions of all configs on the [Config](/config/) page.
+You can find detailed descriptions of all configs on the [Configure Overview](/config/) page.
 
 ## Configuration Usage
 

diff --git a/packages/document/docs/en/guide/debug/debug-mode.md b/packages/document/docs/en/guide/debug/debug-mode.md
@@ -54,7 +54,7 @@ export default {
 };
 ```
 
-For a complete introduction to Rsbuild config, please see the [Rsbuild Config](/guide/basic/config) chapter.
+For a complete introduction to Rsbuild config, please see the [Configure Rsbuild](/guide/basic/configure-rsbuild) chapter.
 
 ## Rspack Config File
 

diff --git a/packages/document/docs/en/guide/start/index.mdx b/packages/document/docs/en/guide/start/index.mdx
@@ -69,7 +69,7 @@ import Step from '@components/Step';
     description="Learn all features of Rsbuild"
   />
   <Step
-    href="/guide/basic/config.html"
+    href="/guide/basic/configure-rsbuild.html"
     title="Config"
     description="Learn how to configure Rsbuild"
   />

diff --git a/packages/document/docs/en/guide/start/quick-start.mdx b/packages/document/docs/en/guide/start/quick-start.mdx
@@ -95,7 +95,7 @@ import Step from '@components/Step';
     description="Learn all features of Rsbuild"
   />
   <Step
-    href="/guide/basic/config.html"
+    href="/guide/basic/configure-rsbuild.html"
     title="Config"
     description="Learn how to configure Rsbuild"
   />

diff --git a/packages/document/docs/zh/config/index.mdx b/packages/document/docs/zh/config/index.mdx
@@ -1,5 +1,7 @@
 # Config 总览
 
+当前页面列出了 Rsbuild 所有的配置项，请查看 [「配置 Rsbuild」](/guide/basic/configure-rsbuild) 了解使用方式。
+
 import Overview from '@components/Overview';
 
 <Overview />
diff --git a/packages/document/docs/zh/config/tools/bundler-chain.mdx b/packages/document/docs/zh/config/tools/bundler-chain.mdx
@@ -222,4 +222,4 @@ Rsbuild 中预先定义了一些常用的 Chain ID，你可以通过这些 ID
 
 ### 使用示例
 
-使用示例可参考：[BundlerChain 示例](/guide/basic/configure-rspack#示例)。
+使用示例可参考：[BundlerChain 示例](/guide/basic/configure-rsbuild#示例)。
diff --git a/packages/document/docs/zh/guide/basic/_meta.json b/packages/document/docs/zh/guide/basic/_meta.json
@@ -1,13 +1,13 @@
 [
   "cli",
-  "config",
   "server",
   "output-files",
   "css-usage",
   "static-assets",
   "json-files",
   "wasm-assets",
   "configure-rspack",
+  "configure-rsbuild",
   "html-template",
   "css-modules",
   "typescript",

diff --git a/...s/document/docs/zh/guide/basic/config.mdx → ...docs/zh/guide/basic/configure-rsbuild.mdx b/...s/document/docs/zh/guide/basic/config.mdx → ...docs/zh/guide/basic/configure-rsbuild.mdx
@@ -1,4 +1,4 @@
-# 配置项
+# 配置 Rsbuild
 
 Rsbuild 提供了丰富的配置项，并为每个配置项预设了一个通用的默认值，它可以满足大部分使用场景。因此，在大多数情况下，你不需要声明任何 Rsbuild 配置，直接开箱使用即可。
 
@@ -16,7 +16,7 @@ Rsbuild 中的配置可以分为以下几类：
 - Output：与构建产物有关的配置。
 - Performance：与编译性能、产物性能有关的配置。
 
-你可以在 [配置](/config/) 页面找到所有配置项的详细说明。
+你可以在 [Config 总览](/config/) 页面找到所有配置项的详细说明。
 
 ## 使用配置
 

diff --git a/packages/document/docs/zh/guide/debug/debug-mode.md b/packages/document/docs/zh/guide/debug/debug-mode.md
@@ -54,7 +54,7 @@ export default {
 };
 ```
 
-关于 Rsbuild 配置项的完整介绍，请查看 [Rsbuild 配置项](/guide/basic/config) 章节。
+关于 Rsbuild 配置项的完整介绍，请查看 [配置 Rsbuild](/guide/basic/configure-rsbuild) 章节。
 
 ## Rspack 配置文件
 

diff --git a/packages/document/docs/zh/guide/start/index.mdx b/packages/document/docs/zh/guide/start/index.mdx
@@ -71,7 +71,7 @@ import Step from '@components/Step';
     description="了解 Rsbuild 提供的所有功能"
   />
   <Step
-    href="/guide/basic/config.html"
+    href="/guide/basic/configure-rsbuild.html"
     title="查阅配置"
     description="了解如何配置 Rsbuild"
   />

diff --git a/packages/document/docs/zh/guide/start/quick-start.mdx b/packages/document/docs/zh/guide/start/quick-start.mdx
@@ -95,7 +95,7 @@ import Step from '@components/Step';
     description="了解 Rsbuild 提供的所有功能"
   />
   <Step
-    href="/guide/basic/config.html"
+    href="/guide/basic/configure-rsbuild.html"
     title="查阅配置"
     description="了解如何配置 Rsbuild"
   />