Skip to content

docs: simplify Rstack CLI agent guidance #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 2 commits into from
Sep 2, 2026
Merged

docs: simplify Rstack CLI agent guidance #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
731074e
docs: simplify Rstack CLI agent guidance
chenjiahan Sep 2, 2026
236efcc
docs: use plain online docs URL
chenjiahan Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/create-rstack/template-common/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# AGENTS.md

This project uses Rstack CLI as its JavaScript toolchain.
This project uses Rstack CLI as its JS toolchain:

- 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.
- For command details, use `rs -h` or `rs <command> -h`.
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed
- Online docs: https://rstack.rs/llms.txt
- Run `rs -h` for CLI help
8 changes: 4 additions & 4 deletions website/docs/en/guide/ai.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Projects created with [create-rstack](https://www.npmjs.com/package/create-rstac
You can also copy the following content into your own `AGENTS.md`:

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

- 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.
- For command details, use `rs -h` or `rs <command> -h`.
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed
- Online docs: https://rstack.rs/llms.txt
- Run `rs -h` for CLI help
```

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.
Expand Down
8 changes: 4 additions & 4 deletions website/docs/zh/guide/ai.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ import { PackageManagerTabs } from '@rspress/core/theme';
你也可以将以下内容复制到自己的 `AGENTS.md` 中：

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

- 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.
- For command details, use `rs -h` or `rs <command> -h`.
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed
- Online docs: https://rstack.rs/llms.txt
- Run `rs -h` for CLI help
```

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