docs: clarify CLI invocation in quick start - #522
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Deploying rstack-cli with
|
| Latest commit: |
42c7148
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8d1f78ea.rstack-cli.pages.dev |
| Branch Preview URL: | https://chenjiahan-docs-cli-invocati.rstack-cli.pages.dev |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 42c7148daf
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| <PackageManagerTabs | ||
| command={{ | ||
| pnpm: 'pnpm rs dev', |
There was a problem hiding this comment.
pnpm exec to bypass package-script dispatch
For an existing project that already defines an rs script, pnpm rs dev dispatches that package script instead of the installed node_modules/.bin/rs, so this “direct” example can execute the wrong command. I confirmed this with pnpm 10.28.1; pnpm help run describes it as running a defined package script, while pnpm help exec explicitly runs a command in the project context. Use pnpm exec rs dev here, update the later alias example similarly, and mirror both corrections in the Chinese guide.
AGENTS.md reference: AGENTS.md:L44-L44
Useful? React with 👍 / 👎.
1 participant
Motivation
The quick start lists
rscommands without clearly showing how to invoke the project-local CLI from a terminal, which contributed to the confusion in #518.Changes
Reorganize the English and Chinese guides into available commands, package scripts, and direct terminal usage. Use
devexamples with package manager tabs and explain therstackalias separately.Validated formatting, spelling, and the documentation build.