From 731074ed28b06e7978fec17b95dcf10880332399 Mon Sep 17 00:00:00 2001 From: neverland Date: Wed, 2 Sep 2026 10:30:25 +0800 Subject: [PATCH 1/2] docs: simplify Rstack CLI agent guidance --- packages/create-rstack/template-common/AGENTS.md | 8 ++++---- website/docs/en/guide/ai.mdx | 8 ++++---- website/docs/zh/guide/ai.mdx | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/packages/create-rstack/template-common/AGENTS.md b/packages/create-rstack/template-common/AGENTS.md index 6f0dd873..7d8ac922 100644 --- a/packages/create-rstack/template-common/AGENTS.md +++ b/packages/create-rstack/template-common/AGENTS.md @@ -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 -h`. -- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs -h`. +- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed +- Online docs: [https://rstack.rs/llms.txt](https://rstack.rs/llms.txt) +- Run `rs -h` for CLI help diff --git a/website/docs/en/guide/ai.mdx b/website/docs/en/guide/ai.mdx index fbcf160c..88dba513 100644 --- a/website/docs/en/guide/ai.mdx +++ b/website/docs/en/guide/ai.mdx @@ -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 -h`. -- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs -h`. +- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed +- Online docs: [https://rstack.rs/llms.txt](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. diff --git a/website/docs/zh/guide/ai.mdx b/website/docs/zh/guide/ai.mdx index 4cb5d7ad..5e8330d0 100644 --- a/website/docs/zh/guide/ai.mdx +++ b/website/docs/zh/guide/ai.mdx @@ -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 -h`. -- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs -h`. +- Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed +- Online docs: [https://rstack.rs/llms.txt](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，任选其一即可。 From 236efcc27cc7c7d48e2fe24fe1c7be0b392d324c Mon Sep 17 00:00:00 2001 From: neverland Date: Wed, 2 Sep 2026 10:33:43 +0800 Subject: [PATCH 2/2] docs: use plain online docs URL --- packages/create-rstack/template-common/AGENTS.md | 2 +- website/docs/en/guide/ai.mdx | 2 +- website/docs/zh/guide/ai.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/create-rstack/template-common/AGENTS.md b/packages/create-rstack/template-common/AGENTS.md index 7d8ac922..65bddf7c 100644 --- a/packages/create-rstack/template-common/AGENTS.md +++ b/packages/create-rstack/template-common/AGENTS.md @@ -3,5 +3,5 @@ This project uses Rstack CLI as its JS toolchain: - Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed -- Online docs: [https://rstack.rs/llms.txt](https://rstack.rs/llms.txt) +- Online docs: https://rstack.rs/llms.txt - Run `rs -h` for CLI help diff --git a/website/docs/en/guide/ai.mdx b/website/docs/en/guide/ai.mdx index 88dba513..e155b3ab 100644 --- a/website/docs/en/guide/ai.mdx +++ b/website/docs/en/guide/ai.mdx @@ -23,7 +23,7 @@ You can also copy the following content into your own `AGENTS.md`: This project uses Rstack CLI as its JS toolchain: - Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed -- Online docs: [https://rstack.rs/llms.txt](https://rstack.rs/llms.txt) +- Online docs: https://rstack.rs/llms.txt - Run `rs -h` for CLI help ``` diff --git a/website/docs/zh/guide/ai.mdx b/website/docs/zh/guide/ai.mdx index 5e8330d0..76f6d308 100644 --- a/website/docs/zh/guide/ai.mdx +++ b/website/docs/zh/guide/ai.mdx @@ -23,7 +23,7 @@ import { PackageManagerTabs } from '@rspress/core/theme'; This project uses Rstack CLI as its JS toolchain: - Read the docs linked from `node_modules/rstack/docs/llms.txt` when needed -- Online docs: [https://rstack.rs/llms.txt](https://rstack.rs/llms.txt) +- Online docs: https://rstack.rs/llms.txt - Run `rs -h` for CLI help ```