Skip to content

Commit 95b2ac3

Browse files
committed
docs: move skills to quick start guide
1 parent 33de1af commit 95b2ac3

3 files changed

Lines changed: 40 additions & 37 deletions

File tree

README.md

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,6 @@ Rstack CLI is currently experimental and mainly used for internal validation. It
3333

3434
Welcome to try it out and share feedback through issues and discussions!
3535

36-
## Skills
37-
38-
### Best practice
39-
40-
Rstack CLI is still new and does not have complete documentation yet.
41-
42-
Installing the Rstack CLI skill so the agent can understand how to use it:
43-
44-
```bash
45-
npx skills add rstackjs/rstack-cli --skill rstack-cli-best-practices
46-
```
47-
48-
### Migration
49-
50-
Installing the migration skill so the agent can migrate existing projects to Rstack CLI:
51-
52-
```bash
53-
npx skills add rstackjs/rstack-cli --skill migrate-to-rstack-cli
54-
```
55-
5636
## Usage
5737

5838
1. Install `rstack` in your project:
@@ -96,23 +76,6 @@ pnpm lib
9676
pnpm doc
9777
```
9878

99-
## API imports
100-
101-
Rstack re-exports the APIs of its underlying tools through dedicated entry points:
102-
103-
| Tool | Import path |
104-
| ------- | ------------- |
105-
| Rsbuild | `rstack/app` |
106-
| Rslib | `rstack/lib` |
107-
| Rslint | `rstack/lint` |
108-
| Rstest | `rstack/test` |
109-
110-
For example, import Rstest APIs without adding `@rstest/core` as a direct dependency:
111-
112-
```ts
113-
import { expect, test } from 'rstack/test';
114-
```
115-
11679
## Credits
11780

11881
Rstack CLI is inspired by:

website/docs/en/guide/quick-start.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,23 @@ define.lint({
8383
```
8484

8585
See [Configuration](./configuration) for all available configuration APIs.
86+
87+
## Skills
88+
89+
### Best practice
90+
91+
Rstack CLI is still new and does not have complete documentation yet.
92+
93+
Install the Rstack CLI skill so the agent can understand how to use it:
94+
95+
```bash
96+
npx skills add rstackjs/rstack-cli --skill rstack-cli-best-practices
97+
```
98+
99+
### Migration
100+
101+
Install the migration skill so the agent can migrate existing projects to Rstack CLI:
102+
103+
```bash
104+
npx skills add rstackjs/rstack-cli --skill migrate-to-rstack-cli
105+
```

website/docs/zh/guide/quick-start.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,23 @@ define.lint({
8383
```
8484

8585
所有可用的配置 API 请参见[配置](./configuration)
86+
87+
## Skills \{#skills}
88+
89+
### 最佳实践 \{#best-practice}
90+
91+
Rstack CLI 仍处于早期阶段,目前尚未提供完整文档。
92+
93+
安装 Rstack CLI Skill,使 Agent 能够了解如何使用 Rstack CLI:
94+
95+
```bash
96+
npx skills add rstackjs/rstack-cli --skill rstack-cli-best-practices
97+
```
98+
99+
### 迁移 \{#migration}
100+
101+
安装迁移 Skill,使 Agent 能够将现有项目迁移到 Rstack CLI:
102+
103+
```bash
104+
npx skills add rstackjs/rstack-cli --skill migrate-to-rstack-cli
105+
```

0 commit comments

Comments
 (0)