Skip to content

Commit ea862b3

Browse files
authored
docs: simplify Rstack CLI agent guidance (#443)
1 parent 7c8df06 commit ea862b3

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# AGENTS.md
22

3-
This project uses Rstack CLI as its JavaScript toolchain.
3+
This project uses Rstack CLI as its JS toolchain:
44

5-
- Before working with `rs` commands, `rstack.config.*` files, or imports from `rstack`, start with `node_modules/rstack/docs/llms.txt`, then read only the linked pages relevant to the task.
6-
- For command details, use `rs -h` or `rs <command> -h`.
7-
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
5+
- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed
6+
- Online docs: https://rstack.rs/llms.txt
7+
- Run `rs -h` for CLI help

‎website/docs/en/guide/ai.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Projects created with [create-rstack](https://www.npmjs.com/package/create-rstac
2020
You can also copy the following content into your own `AGENTS.md`:
2121

2222
```markdown wrapCode title="AGENTS.md"
23-
This project uses Rstack CLI as its JavaScript toolchain.
23+
This project uses Rstack CLI as its JS toolchain:
2424

25-
- Before working with `rs` commands, `rstack.config.*` files, or imports from `rstack`, start with `node_modules/rstack/docs/llms.txt`, then read only the linked pages relevant to the task.
26-
- For command details, use `rs -h` or `rs <command> -h`.
27-
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
25+
- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed
26+
- Online docs: https://rstack.rs/llms.txt
27+
- Run `rs -h` for CLI help
2828
```
2929

3030
This content serves a similar purpose to the [rstack-cli-docs](#rstack-cli-docs) Skill, helping coding agents use Rstack CLI and find relevant documentation. Add it to `AGENTS.md` or install the Skill; either is sufficient.

‎website/docs/zh/guide/ai.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ import { PackageManagerTabs } from '@rspress/core/theme';
2020
你也可以将以下内容复制到自己的 `AGENTS.md` 中:
2121

2222
```markdown wrapCode title="AGENTS.md"
23-
This project uses Rstack CLI as its JavaScript toolchain.
23+
This project uses Rstack CLI as its JS toolchain:
2424

25-
- Before working with `rs` commands, `rstack.config.*` files, or imports from `rstack`, start with `node_modules/rstack/docs/llms.txt`, then read only the linked pages relevant to the task.
26-
- For command details, use `rs -h` or `rs <command> -h`.
27-
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
25+
- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed
26+
- Online docs: https://rstack.rs/llms.txt
27+
- Run `rs -h` for CLI help
2828
```
2929

3030
这段内容与 [rstack-cli-docs](#rstack-cli-docs) Skill 作用相似,都能指导 Coding Agent 使用 Rstack CLI 并查找相关文档。将其添加到 `AGENTS.md` 或安装该 Skill,任选其一即可。

0 commit comments

Comments
 (0)