fix: update quickstart instructions#492
Conversation
to reflect docs.spacebot.sh/quickstart
WalkthroughREADME.md Quick Start build instructions were updated to clone the repository with an explicit Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
| # Without this, OpenCode workers still work — the Workers tab shows a transcript view instead. | ||
| # ./scripts/build-opencode-embed.sh | ||
| # Optional: build the web UI (React + Vite, embedded into the binary) | ||
| cd interface && bun install && cd .. |
There was a problem hiding this comment.
Minor: consider using a subshell here so a failing bun install doesn't leave you in interface.
| cd interface && bun install && cd .. | |
| (cd interface && bun install) |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
428-437: Excellent improvement - clear multi-step build flow.The updated instructions correctly sequence the build steps:
- Optional web UI dependencies
- Optional OpenCode embed (before cargo triggers the Vite build)
- Install the binary via
cargo install --path .The build order is correct based on build.rs behavior, and using
cargo install --path .is more user-friendly thancargo build --releasesince it places the binary directly in~/.cargo/bin/(already in PATH).📝 Optional: Add a note about binary location
Consider adding a brief note after line 437 to clarify where the binary is installed:
# Install the binary cargo install --path . +# The binary will be installed to ~/.cargo/bin/spacebot (ensure ~/.cargo/bin is in your PATH)This helps users understand the difference from the previous
cargo build --releaseapproach, which placed the binary intarget/release/.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 428 - 437, Add a brief note after the cargo install step clarifying that using `cargo install --path .` places the binary in the user's Cargo bin directory (typically ~/.cargo/bin) and that this differs from `cargo build --release`, which leaves the built binary in target/release/; mention this so users understand where to find the executable after running the install command.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@README.md`:
- Around line 428-437: Add a brief note after the cargo install step clarifying
that using `cargo install --path .` places the binary in the user's Cargo bin
directory (typically ~/.cargo/bin) and that this differs from `cargo build
--release`, which leaves the built binary in target/release/; mention this so
users understand where to find the executable after running the install command.
to reflect docs.spacebot.sh/quickstart