docs: add formatting and setup command examples - #222
Conversation
![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: 0cea08e0b2
ℹ️ 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".
| "doc": "rs doc" | ||
| "doc": "rs doc", | ||
| "format": "rs fmt", | ||
| "prepare": "rs setup" |
There was a problem hiding this comment.
When a project already uses Husky or another hook manager, copying this generic scripts block makes each dependency install run rs setup; if the configured path differs, the command replaces core.hooksPath with Rstack's directory (packages/rstack/src/setup/install.ts:160-161), so the project's existing hooks stop running. The dedicated setup guide requires users to migrate those hooks first (website/docs/en/guide/cli/setup.mdx:44), but this quick-start example gives no such caveat. Either omit prepare from the generic block or include the migration warning/link here.
Useful? React with 👍 / 👎.
1 participant
This PR keeps the README usage example aligned with the available CLI workflows. It adds package scripts for formatting and Git hook setup, along with the corresponding pnpm formatting example.