From 03fd5fa900414a9cc8010850fa7613434ab10bfb Mon Sep 17 00:00:00 2001 From: neverland Date: Thu, 8 Oct 2026 11:42:09 +0800 Subject: [PATCH 1/2] docs: add descriptions to command and API references --- website/docs/en/guide/api-reference.mdx | 4 ++++ website/docs/en/guide/cli/build.mdx | 4 ++++ website/docs/en/guide/cli/dev.mdx | 4 ++++ website/docs/en/guide/cli/fmt.mdx | 4 ++++ website/docs/en/guide/cli/lib.mdx | 4 ++++ website/docs/en/guide/cli/lint.mdx | 4 ++++ website/docs/en/guide/cli/preview.mdx | 4 ++++ website/docs/en/guide/cli/test.mdx | 4 ++++ website/docs/en/guide/configuration.mdx | 4 ++++ website/docs/zh/guide/api-reference.mdx | 4 ++++ website/docs/zh/guide/cli/build.mdx | 4 ++++ website/docs/zh/guide/cli/dev.mdx | 4 ++++ website/docs/zh/guide/cli/fmt.mdx | 4 ++++ website/docs/zh/guide/cli/lib.mdx | 4 ++++ website/docs/zh/guide/cli/lint.mdx | 4 ++++ website/docs/zh/guide/cli/preview.mdx | 4 ++++ website/docs/zh/guide/cli/test.mdx | 4 ++++ website/docs/zh/guide/configuration.mdx | 4 ++++ 18 files changed, 72 insertions(+) diff --git a/website/docs/en/guide/api-reference.mdx b/website/docs/en/guide/api-reference.mdx index dd2eba08..218e90c1 100644 --- a/website/docs/en/guide/api-reference.mdx +++ b/website/docs/en/guide/api-reference.mdx @@ -1,3 +1,7 @@ +--- +description: 'Use Rstack configuration APIs, tool API re-exports, and TypeScript declarations through rstack package subpaths.' +--- + # API reference Rstack CLI provides a unified configuration API and re-exports the public APIs of Rsbuild, Rslib, Rstest, and Rslint through dedicated subpaths. Prefer these subpaths to direct imports from each tool's core package so that dependency entry points stay unified and APIs match the tool versions integrated by Rstack CLI. diff --git a/website/docs/en/guide/cli/build.mdx b/website/docs/en/guide/cli/build.mdx index 6f2e7288..e32eb941 100644 --- a/website/docs/en/guide/cli/build.mdx +++ b/website/docs/en/guide/cli/build.mdx @@ -1,3 +1,7 @@ +--- +description: 'Build applications for production with rs build and configure Rsbuild output through define.app().' +--- + # build The `rs build` command uses [Rsbuild](https://rsbuild.rs/guide/basic/cli#rsbuild-build) to build an application for production. diff --git a/website/docs/en/guide/cli/dev.mdx b/website/docs/en/guide/cli/dev.mdx index 1af55342..bcd0f4c2 100644 --- a/website/docs/en/guide/cli/dev.mdx +++ b/website/docs/en/guide/cli/dev.mdx @@ -1,3 +1,7 @@ +--- +description: 'Start the Rsbuild dev server with rs dev, including HMR, host and port options, and define.app() configuration.' +--- + # dev The `rs dev` command starts the [Rsbuild development server](https://rsbuild.rs/guide/basic/server) for an application. It compiles the source code in development mode, watches for changes, and applies hot module replacement (HMR) or reloads the page as needed. diff --git a/website/docs/en/guide/cli/fmt.mdx b/website/docs/en/guide/cli/fmt.mdx index 1dae5d3a..b2b662ba 100644 --- a/website/docs/en/guide/cli/fmt.mdx +++ b/website/docs/en/guide/cli/fmt.mdx @@ -1,3 +1,7 @@ +--- +description: 'Format files or check formatting with rs fmt, including file selection, ignore rules, caching, and stdin input.' +--- + # fmt The `rs fmt` command formats files or checks whether they are formatted. For detailed usage, see [Formatting](../formatting). diff --git a/website/docs/en/guide/cli/lib.mdx b/website/docs/en/guide/cli/lib.mdx index 7c24a343..6c575e8f 100644 --- a/website/docs/en/guide/cli/lib.mdx +++ b/website/docs/en/guide/cli/lib.mdx @@ -1,3 +1,7 @@ +--- +description: 'Build libraries with rs lib, inspect configurations, or start a Module Federation dev server using define.lib().' +--- + # lib The `rs lib` command uses [Rslib](https://rslib.rs/guide/basic/cli#rslib) to build library outputs. diff --git a/website/docs/en/guide/cli/lint.mdx b/website/docs/en/guide/cli/lint.mdx index cbeba63d..c62af1c7 100644 --- a/website/docs/en/guide/cli/lint.mdx +++ b/website/docs/en/guide/cli/lint.mdx @@ -1,3 +1,7 @@ +--- +description: 'Lint source code with rs lint, apply automatic fixes, run type checking, and configure presets through define.lint().' +--- + # lint The `rs lint` command uses [Rslint](https://rslint.rs/guide/) to lint source code. diff --git a/website/docs/en/guide/cli/preview.mdx b/website/docs/en/guide/cli/preview.mdx index dec98212..d5f99d8e 100644 --- a/website/docs/en/guide/cli/preview.mdx +++ b/website/docs/en/guide/cli/preview.mdx @@ -1,3 +1,7 @@ +--- +description: 'Preview an application production build locally with rs preview after running rs build.' +--- + # preview The `rs preview` command uses [Rsbuild](https://rsbuild.rs/guide/basic/cli#rsbuild-preview) to preview an application's production build locally. diff --git a/website/docs/en/guide/cli/test.mdx b/website/docs/en/guide/cli/test.mdx index 08f23e2c..b487a4ec 100644 --- a/website/docs/en/guide/cli/test.mdx +++ b/website/docs/en/guide/cli/test.mdx @@ -1,3 +1,7 @@ +--- +description: 'Run, watch, and filter Rstest tests with rs test, collect coverage, and configure testing through define.test().' +--- + # test The `rs test` command uses [Rstest](https://rstest.rs/guide/basic/cli) to run tests. diff --git a/website/docs/en/guide/configuration.mdx b/website/docs/en/guide/configuration.mdx index e50bb635..3f7f8215 100644 --- a/website/docs/en/guide/configuration.mdx +++ b/website/docs/en/guide/configuration.mdx @@ -1,3 +1,7 @@ +--- +description: 'Configure Rstack tools in rstack.config.ts with define APIs, configuration file selection, and deferred dependency imports.' +--- + # Configuration import { PackageManagerTabs } from '@rspress/core/theme'; diff --git a/website/docs/zh/guide/api-reference.mdx b/website/docs/zh/guide/api-reference.mdx index d61ebb1b..3fe57cc4 100644 --- a/website/docs/zh/guide/api-reference.mdx +++ b/website/docs/zh/guide/api-reference.mdx @@ -1,3 +1,7 @@ +--- +description: '通过 rstack 包子路径使用 Rstack 配置 API、各工具重新导出的 API 和 TypeScript 类型声明。' +--- + # API 参考 \{#api-reference} Rstack CLI 提供统一的配置 API，并通过专用子路径重导出 Rsbuild、Rslib、Rstest 和 Rslint 的公开 API。建议优先从这些子路径导入，而不是直接从各工具的 core 包导入，以统一依赖入口，并确保 API 与 Rstack CLI 集成的工具版本匹配。 diff --git a/website/docs/zh/guide/cli/build.mdx b/website/docs/zh/guide/cli/build.mdx index 62a7288c..2fea65eb 100644 --- a/website/docs/zh/guide/cli/build.mdx +++ b/website/docs/zh/guide/cli/build.mdx @@ -1,3 +1,7 @@ +--- +description: '使用 rs build 构建生产环境应用，并通过 define.app() 配置 Rsbuild 产物。' +--- + # build `rs build` 命令使用 [Rsbuild](https://rsbuild.rs/zh/guide/basic/cli#rsbuild-build) 构建应用的生产版本。 diff --git a/website/docs/zh/guide/cli/dev.mdx b/website/docs/zh/guide/cli/dev.mdx index 331ffaba..5bdb5f41 100644 --- a/website/docs/zh/guide/cli/dev.mdx +++ b/website/docs/zh/guide/cli/dev.mdx @@ -1,3 +1,7 @@ +--- +description: '使用 rs dev 启动 Rsbuild dev server，配置 HMR、主机、端口和 define.app()。' +--- + # dev `rs dev` 命令用于启动应用的 [Rsbuild 开发服务器](https://rsbuild.rs/zh/guide/basic/server)。它会以开发模式编译源码、监听文件变化，并按需进行模块热更新（HMR）或刷新页面。 diff --git a/website/docs/zh/guide/cli/fmt.mdx b/website/docs/zh/guide/cli/fmt.mdx index 8ea9aa81..bab6200f 100644 --- a/website/docs/zh/guide/cli/fmt.mdx +++ b/website/docs/zh/guide/cli/fmt.mdx @@ -1,3 +1,7 @@ +--- +description: '使用 rs fmt 格式化文件或检查格式，了解文件选择、忽略规则、缓存和标准输入。' +--- + # fmt `rs fmt` 命令用于格式化文件或检查文件格式。详细用法请参考[格式化](../formatting)指南。 diff --git a/website/docs/zh/guide/cli/lib.mdx b/website/docs/zh/guide/cli/lib.mdx index 994c658c..41430e8b 100644 --- a/website/docs/zh/guide/cli/lib.mdx +++ b/website/docs/zh/guide/cli/lib.mdx @@ -1,3 +1,7 @@ +--- +description: '通过 rs lib 构建库、检查配置或启动 Module Federation dev server，并使用 define.lib() 配置。' +--- + # lib `rs lib` 命令使用 [Rslib](https://rslib.rs/zh/guide/basic/cli#rslib) 构建库产物。 diff --git a/website/docs/zh/guide/cli/lint.mdx b/website/docs/zh/guide/cli/lint.mdx index 859d69f7..8c395a7c 100644 --- a/website/docs/zh/guide/cli/lint.mdx +++ b/website/docs/zh/guide/cli/lint.mdx @@ -1,3 +1,7 @@ +--- +description: '使用 rs lint 检查源码、自动修复问题、运行类型检查，并通过 define.lint() 配置预设。' +--- + # lint `rs lint` 命令使用 [Rslint](https://rslint.rs/guide/) 检查源代码。 diff --git a/website/docs/zh/guide/cli/preview.mdx b/website/docs/zh/guide/cli/preview.mdx index 104472fe..7bcf8048 100644 --- a/website/docs/zh/guide/cli/preview.mdx +++ b/website/docs/zh/guide/cli/preview.mdx @@ -1,3 +1,7 @@ +--- +description: '运行 rs build 后，使用 rs preview 在本地预览应用的生产构建产物。' +--- + # preview `rs preview` 命令使用 [Rsbuild](https://rsbuild.rs/zh/guide/basic/cli#rsbuild-preview) 在本地预览应用的生产构建。 diff --git a/website/docs/zh/guide/cli/test.mdx b/website/docs/zh/guide/cli/test.mdx index d4ce4ac5..72d3369c 100644 --- a/website/docs/zh/guide/cli/test.mdx +++ b/website/docs/zh/guide/cli/test.mdx @@ -1,3 +1,7 @@ +--- +description: '通过 rs test 运行、监听和筛选 Rstest 测试，收集覆盖率，并使用 define.test() 配置测试。' +--- + # test `rs test` 命令使用 [Rstest](https://rstest.rs/zh/guide/basic/cli) 运行测试。 diff --git a/website/docs/zh/guide/configuration.mdx b/website/docs/zh/guide/configuration.mdx index cd9558e4..8fc833bd 100644 --- a/website/docs/zh/guide/configuration.mdx +++ b/website/docs/zh/guide/configuration.mdx @@ -1,3 +1,7 @@ +--- +description: '通过 define API 在 rstack.config.ts 中配置 Rstack 工具，并了解配置文件选择和依赖延迟导入。' +--- + # 配置 \{#configuration} import { PackageManagerTabs } from '@rspress/core/theme'; From df852d2386ba70bdf063242aaa4b230ff9a716f5 Mon Sep 17 00:00:00 2001 From: neverland Date: Thu, 8 Oct 2026 13:00:57 +0800 Subject: [PATCH 2/2] docs: describe scope with representative examples --- website/docs/en/guide/api-reference.mdx | 2 +- website/docs/en/guide/cli/lib.mdx | 2 +- website/docs/en/guide/cli/test.mdx | 2 +- website/docs/en/guide/configuration.mdx | 2 +- website/docs/zh/guide/api-reference.mdx | 2 +- website/docs/zh/guide/cli/lib.mdx | 2 +- website/docs/zh/guide/cli/test.mdx | 2 +- website/docs/zh/guide/configuration.mdx | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/website/docs/en/guide/api-reference.mdx b/website/docs/en/guide/api-reference.mdx index 218e90c1..4a28006e 100644 --- a/website/docs/en/guide/api-reference.mdx +++ b/website/docs/en/guide/api-reference.mdx @@ -1,5 +1,5 @@ --- -description: 'Use Rstack configuration APIs, tool API re-exports, and TypeScript declarations through rstack package subpaths.' +description: 'Public Rstack APIs, including configuration helpers, tool API re-exports, and TypeScript declarations.' --- # API reference diff --git a/website/docs/en/guide/cli/lib.mdx b/website/docs/en/guide/cli/lib.mdx index 6c575e8f..6e3195e2 100644 --- a/website/docs/en/guide/cli/lib.mdx +++ b/website/docs/en/guide/cli/lib.mdx @@ -1,5 +1,5 @@ --- -description: 'Build libraries with rs lib, inspect configurations, or start a Module Federation dev server using define.lib().' +description: 'Build and develop libraries with rs lib, including build, inspect, and mf-dev commands.' --- # lib diff --git a/website/docs/en/guide/cli/test.mdx b/website/docs/en/guide/cli/test.mdx index b487a4ec..2d9c6b8a 100644 --- a/website/docs/en/guide/cli/test.mdx +++ b/website/docs/en/guide/cli/test.mdx @@ -1,5 +1,5 @@ --- -description: 'Run, watch, and filter Rstest tests with rs test, collect coverage, and configure testing through define.test().' +description: 'Run Rstest through rs test, including test execution, watch mode, filtering, and coverage.' --- # test diff --git a/website/docs/en/guide/configuration.mdx b/website/docs/en/guide/configuration.mdx index 3f7f8215..5ac15d1a 100644 --- a/website/docs/en/guide/configuration.mdx +++ b/website/docs/en/guide/configuration.mdx @@ -1,5 +1,5 @@ --- -description: 'Configure Rstack tools in rstack.config.ts with define APIs, configuration file selection, and deferred dependency imports.' +description: 'Configure Rstack tools with define APIs in rstack.config.ts, including application builds, tests, linting, and formatting.' --- # Configuration diff --git a/website/docs/zh/guide/api-reference.mdx b/website/docs/zh/guide/api-reference.mdx index 3fe57cc4..16c373fc 100644 --- a/website/docs/zh/guide/api-reference.mdx +++ b/website/docs/zh/guide/api-reference.mdx @@ -1,5 +1,5 @@ --- -description: '通过 rstack 包子路径使用 Rstack 配置 API、各工具重新导出的 API 和 TypeScript 类型声明。' +description: 'Rstack 公共 API，包括配置辅助方法、各工具重新导出的 API 和 TypeScript 类型声明。' --- # API 参考 \{#api-reference} diff --git a/website/docs/zh/guide/cli/lib.mdx b/website/docs/zh/guide/cli/lib.mdx index 41430e8b..93252c82 100644 --- a/website/docs/zh/guide/cli/lib.mdx +++ b/website/docs/zh/guide/cli/lib.mdx @@ -1,5 +1,5 @@ --- -description: '通过 rs lib 构建库、检查配置或启动 Module Federation dev server，并使用 define.lib() 配置。' +description: '通过 rs lib 构建和开发库，包括 build、inspect 和 mf-dev 等命令。' --- # lib diff --git a/website/docs/zh/guide/cli/test.mdx b/website/docs/zh/guide/cli/test.mdx index 72d3369c..75dfb958 100644 --- a/website/docs/zh/guide/cli/test.mdx +++ b/website/docs/zh/guide/cli/test.mdx @@ -1,5 +1,5 @@ --- -description: '通过 rs test 运行、监听和筛选 Rstest 测试，收集覆盖率，并使用 define.test() 配置测试。' +description: '通过 rs test 使用 Rstest，包括执行测试、监听模式、测试筛选和覆盖率收集等。' --- # test diff --git a/website/docs/zh/guide/configuration.mdx b/website/docs/zh/guide/configuration.mdx index 8fc833bd..dc47fa55 100644 --- a/website/docs/zh/guide/configuration.mdx +++ b/website/docs/zh/guide/configuration.mdx @@ -1,5 +1,5 @@ --- -description: '通过 define API 在 rstack.config.ts 中配置 Rstack 工具，并了解配置文件选择和依赖延迟导入。' +description: '通过 define API 在 rstack.config.ts 中配置 Rstack 工具，包括应用构建、测试、代码检查和格式化等。' --- # 配置 \{#configuration}