Skip to content

Fix documented task-runner commands (bun run -> vp)#3965

Open
kridaydave wants to merge 2 commits into
pingdotgg:mainfrom
kridaydave:fix/docs-task-runner-commands
Open

Fix documented task-runner commands (bun run -> vp)#3965
kridaydave wants to merge 2 commits into
pingdotgg:mainfrom
kridaydave:fix/docs-task-runner-commands

Conversation

@kridaydave

@kridaydave kridaydave commented Jul 14, 2026

Copy link
Copy Markdown

The docs used bun run for 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 real vp commands 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 uses vp.


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 of bun run.

CI (docs/operations/ci.md): quality gates are documented as vp check, vpr typecheck, and vp run test.

Scripts (docs/reference/scripts.md): dev/build/test/dist examples use vp run …; dev home is T3CODE_HOME (default ~/.t3, shared with desktop/prod) with --home-dir to isolate dev state; default dev server port is 13773; production DMG icon path is assets/prod/black-macos-1024.png; multi-instance examples use vp 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/vpr instead of bun run

Updates docs/operations/ci.md and docs/reference/scripts.md to reflect the current task-runner interface.

  • Replaces bun run lint, bun run typecheck, and bun run test with vp check, vpr typecheck, and vp run test in the CI docs
  • Updates all script examples in the reference docs from bun run to vp run
  • Changes the default dev state variable from T3CODE_STATE_DIR to T3CODE_HOME and replaces the --base-dir flag with --home-dir
  • Updates the default server port in multi-instance dev examples from 3773 to 13773
  • Updates the macOS icon path in Desktop .dmg notes from assets/macos-icon-1024.png to assets/prod/black-macos-1024.png

Macroscope summarized 797a7de.

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: bcb1d80b-31a2-4023-99d5-2017b26458ca

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added vouch:unvouched PR author is not yet trusted in the VOUCHED list. size:M 30-99 changed lines (additions + deletions). labels Jul 14, 2026
Comment thread docs/reference/scripts.md Outdated
Comment thread docs/reference/scripts.md Outdated
@macroscopeapp

macroscopeapp Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Approvability

Verdict: 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.

@juliusmarminge juliusmarminge enabled auto-merge (squash) July 14, 2026 16:02
auto-merge was automatically disabled July 14, 2026 16:03

Head branch was pushed to by a user without write access

@kridaydave kridaydave force-pushed the fix/docs-task-runner-commands branch 2 times, most recently from 4d6e2ef to 299f768 Compare July 14, 2026 16:05

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/reference/scripts.md Outdated
macroscopeapp[bot]
macroscopeapp Bot previously approved these changes Jul 14, 2026
@kridaydave kridaydave force-pushed the fix/docs-task-runner-commands branch from 299f768 to 98c2890 Compare July 14, 2026 16:12
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@macroscopeapp macroscopeapp Bot dismissed their stale review July 14, 2026 16:12

Dismissing prior approval to re-evaluate 98c2890

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30-99 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants