Fix documented task-runner commands (bun run -> vp)#3965
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
ApprovabilityVerdict: Approved Documentation-only changes updating task-runner command examples in markdown files. No runtime code is modified. You can customize Macroscope's approvability policy. Learn more. |
Head branch was pushed to by a user without write access
4d6e2ef to
299f768
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ff849da739
ℹ️ 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".
299f768 to
98c2890
Compare
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Dismissing prior approval to re-evaluate 98c2890
The docs used
bun runfor task running, but this repo mandates Vite+ (vp) as the task runner (README/CONTRIBUTING/ci). This updates docs/reference/scripts.md and docs/operations/ci.md to the realvpcommands and fixes a few related inaccuracies in scripts.md (server port, env var, CLI flag, icon path, a double-negative typo). Note: the server process runs on Bun, but task running usesvp.Note
Low Risk
Markdown-only changes with no runtime or CI workflow edits; risk is limited to doc accuracy for contributors.
Overview
Updates operations and reference docs so examples match the repo’s Vite+ (
vp/vpr) task runner instead ofbun run.CI (
docs/operations/ci.md): quality gates are documented asvp check,vpr typecheck, andvp run test.Scripts (
docs/reference/scripts.md): dev/build/test/dist examples usevp run …; dev home isT3CODE_HOME(default~/.t3, shared with desktop/prod) with--home-dirto isolate dev state; default dev server port is 13773; production DMG icon path isassets/prod/black-macos-1024.png; multi-instance examples usevp run dev:desktop.Reviewed by Cursor Bugbot for commit 797a7de. Bugbot is set up for automated code reviews on this repo. Configure here.
Note
Fix documented task-runner commands to use
vp/vprinstead ofbun runUpdates docs/operations/ci.md and docs/reference/scripts.md to reflect the current task-runner interface.
bun run lint,bun run typecheck, andbun run testwithvp check,vpr typecheck, andvp run testin the CI docsbun runtovp runT3CODE_STATE_DIRtoT3CODE_HOMEand replaces the--base-dirflag with--home-dir3773to13773.dmgnotes fromassets/macos-icon-1024.pngtoassets/prod/black-macos-1024.pngMacroscope summarized 797a7de.