docs: Add instructions for installing dependencies and change build directory to avoid mixing Spider & dependencies. - #122
Conversation
WalkthroughThe quick start guide was revised to introduce an optional step for installing Spider dependencies locally using the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Task
participant BuildSystem
participant Client
User->>Task: Run deps:lib_install (optional)
Task->>BuildSystem: Install dependencies in build/deps
User->>BuildSystem: Build using build/spider directory
User->>Client: Run client from build/spider/client
Assessment against linked issues
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/src/user-docs/guides-quick-start.md (2)
7-7: Ensure consistency in section titles and linksThe bullet at line 7 reads “(Optional) Install Dependencies” but the corresponding section at line 69 is titled “(Optional) Installing dependencies”. Consider normalizing the phrasing (e.g. “Install dependencies”) and adding an inline link in the bullet to jump directly to that section for better discoverability.
69-75: Clarify optional dependency installation flowThe new “(Optional) Installing dependencies” section is helpful, but its placement between “Writing a task” and “Building the task” may interrupt the reader’s flow. Consider:
- Adding a brief note about why dependencies might not be needed if managed externally.
- Ensuring the bullet at line 7 hyperlinks to this section (auto-generated anchors or explicit links).
- Possibly moving this block immediately before the “Building the task” section for coherence.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/src/user-docs/guides-quick-start.md(8 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: non-storage-unit-tests (ubuntu-22.04)
- GitHub Check: non-storage-unit-tests (ubuntu-24.04)
- GitHub Check: lint
🔇 Additional comments (3)
docs/src/user-docs/guides-quick-start.md (3)
32-32: Good addition of Task requirementSpecifying
Task v3.30.0+as a prerequisite for local dependency installation helps users avoid version mismatches. This aligns nicely with the new optional deps feature.
90-91: Update build directory commandsUpdating the CMake commands to target
build/spiderinstead ofbuildcorrectly reflects the new directory structure and prevents mixing dependency files with CMake artifacts.
130-130: Confirm client build target pathThe client build instruction now uses
build/spider --target client, which matches the updated layout and should produce the executable in the expected location.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
kirkrodrigues
left a comment
kirkrodrigues
left a comment
There was a problem hiding this comment.
For the PR title, how about:
docs: Add instructions for installing dependencies and change build directory to avoid mixing Spider & dependencies.
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
2 participants
Description
This pr adds the dependencies building using
taskin quick start guide. This pr also changes the build directory frombuildtobuild/spiderto avoid mixing the dependencies inbuild/depswith cmake-related files, fixes #118.Checklist
breaking change.
Validation performed
Summary by CodeRabbit
build/spiderdirectory.