docs: organize CLI documentation (#50)

chenjiahan · web-flow · commit ee8aec9586d5 · 2026-07-20T17:51:46.000+08:00
diff --git a/website/docs/en/_nav.json b/website/docs/en/_nav.json
@@ -1,19 +1,9 @@
 [
   {
     "text": "Guide",
-    "link": "/guide/introduction",
+    "link": "/guide/quick-start",
     "activeMatch": "/guide/"
   },
-  {
-    "text": "Commands",
-    "link": "/commands/",
-    "activeMatch": "/commands/"
-  },
-  {
-    "text": "Configuration",
-    "link": "/config/",
-    "activeMatch": "/config/"
-  },
   {
     "text": "Changelog",
     "link": "https://github.com/rstackjs/rstack-cli/releases"
diff --git a/website/docs/en/commands/_meta.json b/website/docs/en/commands/_meta.json
diff --git a/website/docs/en/commands/index.mdx b/website/docs/en/commands/index.mdx
diff --git a/website/docs/en/config/_meta.json b/website/docs/en/config/_meta.json
diff --git a/website/docs/en/config/index.mdx b/website/docs/en/config/index.mdx
diff --git a/website/docs/en/guide/_meta.json b/website/docs/en/guide/_meta.json
@@ -1,12 +1,21 @@
 [
   {
-    "type": "file",
-    "name": "introduction",
-    "label": "Introduction"
+    "type": "section-header",
+    "label": "Essentials"
   },
   {
     "type": "file",
     "name": "quick-start",
     "label": "Quick start"
+  },
+  {
+    "type": "file",
+    "name": "configuration",
+    "label": "Configuration"
+  },
+  {
+    "type": "dir-section-header",
+    "name": "cli",
+    "label": "CLI"
   }
 ]
diff --git a/website/docs/en/guide/cli/_meta.json b/website/docs/en/guide/cli/_meta.json
@@ -0,0 +1 @@
+["dev", "build", "preview", "lib", "doc", "test", "lint", "staged"]
diff --git a/website/docs/en/guide/cli/build.mdx b/website/docs/en/guide/cli/build.mdx
@@ -0,0 +1,7 @@
+# build
+
+TODO.
+
+## Configuration
+
+See [`define.app()`](../configuration#define-app).
diff --git a/website/docs/en/guide/cli/dev.mdx b/website/docs/en/guide/cli/dev.mdx
@@ -0,0 +1,7 @@
+# dev
+
+TODO.
+
+## Configuration
+
+See [`define.app()`](../configuration#define-app).
diff --git a/website/docs/en/guide/cli/doc.mdx b/website/docs/en/guide/cli/doc.mdx
@@ -0,0 +1,7 @@
+# doc
+
+TODO.
+
+## Configuration
+
+See [`define.doc()`](../configuration#define-doc).
diff --git a/website/docs/en/guide/cli/lib.mdx b/website/docs/en/guide/cli/lib.mdx
@@ -0,0 +1,7 @@
+# lib
+
+TODO.
+
+## Configuration
+
+See [`define.lib()`](../configuration#define-lib).
diff --git a/website/docs/en/guide/cli/lint.mdx b/website/docs/en/guide/cli/lint.mdx
@@ -0,0 +1,7 @@
+# lint
+
+TODO.
+
+## Configuration
+
+See [`define.lint()`](../configuration#define-lint).
diff --git a/website/docs/en/guide/cli/preview.mdx b/website/docs/en/guide/cli/preview.mdx
@@ -0,0 +1,7 @@
+# preview
+
+TODO.
+
+## Configuration
+
+See [`define.app()`](../configuration#define-app).
diff --git a/website/docs/en/guide/cli/staged.mdx b/website/docs/en/guide/cli/staged.mdx
@@ -0,0 +1,7 @@
+# staged
+
+TODO.
+
+## Configuration
+
+See [`define.staged()`](../configuration#define-staged).
diff --git a/website/docs/en/guide/cli/test.mdx b/website/docs/en/guide/cli/test.mdx
@@ -0,0 +1,7 @@
+# test
+
+TODO.
+
+## Configuration
+
+See [`define.test()`](../configuration#define-test).
diff --git a/website/docs/en/guide/configuration.mdx b/website/docs/en/guide/configuration.mdx
@@ -0,0 +1,43 @@
+# Configuration
+
+TODO.
+
+## `define.app()` \{#define-app}
+
+TODO.
+
+Commands:
+
+- [`rs dev`](./cli/dev)
+- [`rs build`](./cli/build)
+- [`rs preview`](./cli/preview)
+
+## `define.lib()` \{#define-lib}
+
+TODO.
+
+Command: [`rs lib`](./cli/lib).
+
+## `define.doc()` \{#define-doc}
+
+TODO.
+
+Command: [`rs doc`](./cli/doc).
+
+## `define.test()` \{#define-test}
+
+TODO.
+
+Command: [`rs test`](./cli/test).
+
+## `define.lint()` \{#define-lint}
+
+TODO.
+
+Command: [`rs lint`](./cli/lint).
+
+## `define.staged()` \{#define-staged}
+
+TODO.
+
+Command: [`rs staged`](./cli/staged).
diff --git a/website/docs/en/guide/introduction.mdx b/website/docs/en/guide/introduction.mdx
diff --git a/website/docs/en/guide/quick-start.mdx b/website/docs/en/guide/quick-start.mdx
@@ -1,3 +1,14 @@
 # Quick start
 
 TODO.
+
+## CLI commands
+
+- [`rs dev`](./cli/dev): TODO.
+- [`rs build`](./cli/build): TODO.
+- [`rs preview`](./cli/preview): TODO.
+- [`rs lib`](./cli/lib): TODO.
+- [`rs doc`](./cli/doc): TODO.
+- [`rs test`](./cli/test): TODO.
+- [`rs lint`](./cli/lint): TODO.
+- [`rs staged`](./cli/staged): TODO.
diff --git a/website/docs/zh/_nav.json b/website/docs/zh/_nav.json
@@ -1,19 +1,9 @@
 [
   {
     "text": "指南",
-    "link": "/guide/introduction",
+    "link": "/guide/quick-start",
     "activeMatch": "/guide/"
   },
-  {
-    "text": "命令",
-    "link": "/commands/",
-    "activeMatch": "/commands/"
-  },
-  {
-    "text": "配置",
-    "link": "/config/",
-    "activeMatch": "/config/"
-  },
   {
     "text": "更新日志",
     "link": "https://github.com/rstackjs/rstack-cli/releases"
diff --git a/website/docs/zh/commands/_meta.json b/website/docs/zh/commands/_meta.json
diff --git a/website/docs/zh/commands/index.mdx b/website/docs/zh/commands/index.mdx
diff --git a/website/docs/zh/config/_meta.json b/website/docs/zh/config/_meta.json
diff --git a/website/docs/zh/config/index.mdx b/website/docs/zh/config/index.mdx
diff --git a/website/docs/zh/guide/_meta.json b/website/docs/zh/guide/_meta.json
@@ -1,12 +1,21 @@
 [
   {
-    "type": "file",
-    "name": "introduction",
-    "label": "介绍"
+    "type": "section-header",
+    "label": "基础"
   },
   {
     "type": "file",
     "name": "quick-start",
     "label": "快速上手"
+  },
+  {
+    "type": "file",
+    "name": "configuration",
+    "label": "配置"
+  },
+  {
+    "type": "dir-section-header",
+    "name": "cli",
+    "label": "CLI"
   }
 ]
diff --git a/website/docs/zh/guide/cli/_meta.json b/website/docs/zh/guide/cli/_meta.json
@@ -0,0 +1 @@
+["dev", "build", "preview", "lib", "doc", "test", "lint", "staged"]
diff --git a/website/docs/zh/guide/cli/build.mdx b/website/docs/zh/guide/cli/build.mdx
@@ -0,0 +1,7 @@
+# build
+
+TODO.
+
+## 配置
+
+参见 [`define.app()`](../configuration#define-app)。
diff --git a/website/docs/zh/guide/cli/dev.mdx b/website/docs/zh/guide/cli/dev.mdx
@@ -0,0 +1,7 @@
+# dev
+
+TODO.
+
+## 配置
+
+参见 [`define.app()`](../configuration#define-app)。
diff --git a/website/docs/zh/guide/cli/doc.mdx b/website/docs/zh/guide/cli/doc.mdx
@@ -0,0 +1,7 @@
+# doc
+
+TODO.
+
+## 配置
+
+参见 [`define.doc()`](../configuration#define-doc)。
diff --git a/website/docs/zh/guide/cli/lib.mdx b/website/docs/zh/guide/cli/lib.mdx
@@ -0,0 +1,7 @@
+# lib
+
+TODO.
+
+## 配置
+
+参见 [`define.lib()`](../configuration#define-lib)。
diff --git a/website/docs/zh/guide/cli/lint.mdx b/website/docs/zh/guide/cli/lint.mdx
@@ -0,0 +1,7 @@
+# lint
+
+TODO.
+
+## 配置
+
+参见 [`define.lint()`](../configuration#define-lint)。
diff --git a/website/docs/zh/guide/cli/preview.mdx b/website/docs/zh/guide/cli/preview.mdx
@@ -0,0 +1,7 @@
+# preview
+
+TODO.
+
+## 配置
+
+参见 [`define.app()`](../configuration#define-app)。
diff --git a/website/docs/zh/guide/cli/staged.mdx b/website/docs/zh/guide/cli/staged.mdx
@@ -0,0 +1,7 @@
+# staged
+
+TODO.
+
+## 配置
+
+参见 [`define.staged()`](../configuration#define-staged)。
diff --git a/website/docs/zh/guide/cli/test.mdx b/website/docs/zh/guide/cli/test.mdx
@@ -0,0 +1,7 @@
+# test
+
+TODO.
+
+## 配置
+
+参见 [`define.test()`](../configuration#define-test)。
diff --git a/website/docs/zh/guide/configuration.mdx b/website/docs/zh/guide/configuration.mdx
@@ -0,0 +1,43 @@
+# 配置
+
+TODO.
+
+## `define.app()` \{#define-app}
+
+TODO.
+
+对应命令：
+
+- [`rs dev`](./cli/dev)
+- [`rs build`](./cli/build)
+- [`rs preview`](./cli/preview)
+
+## `define.lib()` \{#define-lib}
+
+TODO.
+
+对应命令：[`rs lib`](./cli/lib)。
+
+## `define.doc()` \{#define-doc}
+
+TODO.
+
+对应命令：[`rs doc`](./cli/doc)。
+
+## `define.test()` \{#define-test}
+
+TODO.
+
+对应命令：[`rs test`](./cli/test)。
+
+## `define.lint()` \{#define-lint}
+
+TODO.
+
+对应命令：[`rs lint`](./cli/lint)。
+
+## `define.staged()` \{#define-staged}
+
+TODO.
+
+对应命令：[`rs staged`](./cli/staged)。
diff --git a/website/docs/zh/guide/introduction.mdx b/website/docs/zh/guide/introduction.mdx
diff --git a/website/docs/zh/guide/quick-start.mdx b/website/docs/zh/guide/quick-start.mdx
@@ -1,3 +1,14 @@
 # 快速上手
 
 TODO.
+
+## CLI 命令
+
+- [`rs dev`](./cli/dev)：TODO。
+- [`rs build`](./cli/build)：TODO。
+- [`rs preview`](./cli/preview)：TODO。
+- [`rs lib`](./cli/lib)：TODO。
+- [`rs doc`](./cli/doc)：TODO。
+- [`rs test`](./cli/test)：TODO。
+- [`rs lint`](./cli/lint)：TODO。
+- [`rs staged`](./cli/staged)：TODO。
diff --git a/website/i18n.json b/website/i18n.json
diff --git a/website/theme/components/HomeFooter.tsx b/website/theme/components/HomeFooter.tsx

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,21 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`		`- "type": "file",`
`4`		`- "name": "introduction",`
`5`		`- "label": "Introduction"`
	`3`	`+ "type": "section-header",`
	`4`	`+ "label": "Essentials"`
`6`	`5`	`},`
`7`	`6`	`{`
`8`	`7`	`"type": "file",`
`9`	`8`	`"name": "quick-start",`
`10`	`9`	`"label": "Quick start"`
	`10`	`+ },`
	`11`	`+ {`
	`12`	`+ "type": "file",`
	`13`	`+ "name": "configuration",`
	`14`	`+ "label": "Configuration"`
	`15`	`+ },`
	`16`	`+ {`
	`17`	`+ "type": "dir-section-header",`
	`18`	`+ "name": "cli",`
	`19`	`+ "label": "CLI"`
`11`	`20`	`}`
`12`	`21`	`]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+["dev", "build", "preview", "lib", "doc", "test", "lint", "staged"]`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +# build
++
 +TODO.
++
 +## Configuration
++
 +See [`define.app()`](../configuration#define-app).