Skip to content

Commit 49ed64d

Browse files
authored
refactor: move package docs outside dist (#278)
1 parent d246486 commit 49ed64d

7 files changed

Lines changed: 7 additions & 5 deletions

File tree

.agents/skills/rstack-cli-best-practices/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before any Rstack work, find and read the relevant Markdown documentation shippe
1616

1717
Model knowledge can be outdated; the installed documentation is the source of truth for the project's Rstack version.
1818

19-
1. Start with `node_modules/rstack/dist/docs/llms.txt`, then read only the linked pages relevant to the task before proposing or making changes.
19+
1. Start with `node_modules/rstack/docs/llms.txt`, then read only the linked pages relevant to the task before proposing or making changes.
2020

2121
2. For exact CLI flags and behavior, also run `rs -h` or `rs <command> -h` when supported.
2222

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
node_modules
88
dist/
99
dist-*/
10+
/packages/rstack/docs/
1011
test-results
1112
doc_build
1213

packages/create-rstack/template-common/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
This project uses Rstack CLI as its JavaScript toolchain.
44

5-
- Before working with `rs` commands, `rstack.config.*` files, or imports from `rstack`, start with `node_modules/rstack/dist/docs/llms.txt`, then read only the linked pages relevant to the task.
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.
66
- For command details, use `rs -h` or `rs <command> -h`.
77
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.

packages/rstack/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
"binding.cjs",
6060
"binding.d.cts",
6161
"dist",
62+
"docs",
6263
"types",
6364
"THIRD_PARTY_NOTICES.md"
6465
],

scripts/prepare-release.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import path from 'node:path';
66
const rootDir = path.resolve(import.meta.dirname, '..');
77
const websiteDir = path.join(rootDir, 'website');
88
const websiteDistDir = path.join(websiteDir, 'doc_build');
9-
const packageDocsDir = path.join(rootDir, 'packages/rstack/dist/docs');
9+
const packageDocsDir = path.join(rootDir, 'packages/rstack/docs');
1010

1111
const run = (command, args) =>
1212
new Promise((resolve, reject) => {

website/docs/en/guide/ai.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can also copy the following content into your own `AGENTS.md`:
2222
```markdown wrapCode title="AGENTS.md"
2323
This project uses Rstack CLI as its JavaScript toolchain.
2424

25-
- Before working with `rs` commands, `rstack.config.*` files, or imports from `rstack`, start with `node_modules/rstack/dist/docs/llms.txt`, then read only the linked pages relevant to the task.
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.
2626
- For command details, use `rs -h` or `rs <command> -h`.
2727
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
2828
```

website/docs/zh/guide/ai.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { PackageManagerTabs } from '@rspress/core/theme';
2222
```markdown wrapCode title="AGENTS.md"
2323
This project uses Rstack CLI as its JavaScript toolchain.
2424

25-
- Before working with `rs` commands, `rstack.config.*` files, or imports from `rstack`, start with `node_modules/rstack/dist/docs/llms.txt`, then read only the linked pages relevant to the task.
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.
2626
- For command details, use `rs -h` or `rs <command> -h`.
2727
- If the local documentation is unavailable, use https://rstack.rs/llms.txt and `rs <command> -h`.
2828
```

0 commit comments

Comments
 (0)