Skip to content

fix: update quickstart instructions#492

Open
blakkd wants to merge 1 commit intospacedriveapp:mainfrom
blakkd:main
Open

fix: update quickstart instructions#492
blakkd wants to merge 1 commit intospacedriveapp:mainfrom
blakkd:main

Conversation

@blakkd
Copy link

@blakkd blakkd commented Mar 25, 2026

to reflect docs.spacebot.sh/quickstart

to reflect docs.spacebot.sh/quickstart
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 25, 2026

Walkthrough

README.md Quick Start build instructions were updated to clone the repository with an explicit .git suffix and replace the single cargo build --release command with a multi-step build flow that optionally builds embedded web UI and OpenCode UI before installing the binary via cargo install --path ..

Changes

Cohort / File(s) Summary
Build Documentation
README.md
Updated Quick Start instructions to include explicit .git suffix in clone command, introduce optional embedded UI builds (web UI via bun and OpenCode UI via ./scripts/build-opencode-embed.sh with Node 22+ requirement), and replace cargo build --release with cargo install --path . for binary installation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: update quickstart instructions' directly matches the changeset, which updates the README.md quickstart build instructions with new steps for building the embedded web UI and OpenCode UI.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description directly references updating quickstart instructions to reflect external documentation, which aligns with the changeset modifications to README.md.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

# 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 ..
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor: consider using a subshell here so a failing bun install doesn't leave you in interface.

Suggested change
cd interface && bun install && cd ..
(cd interface && bun install)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

428-437: Excellent improvement - clear multi-step build flow.

The updated instructions correctly sequence the build steps:

  1. Optional web UI dependencies
  2. Optional OpenCode embed (before cargo triggers the Vite build)
  3. 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 than cargo build --release since 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 --release approach, which placed the binary in target/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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7648efbb-ae30-4618-adf8-b3ba72e28a45

📥 Commits

Reviewing files that changed from the base of the PR and between b7d5dd2 and f32ddaf.

📒 Files selected for processing (1)
  • README.md

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant