adding rust to docs #8937
adding rust to docs #8937
Conversation
WalkthroughThe pull request updates the development environment setup instructions for multiple operating systems. The changes focus on adding Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 0
🔭 Outside diff range comments (1)
site/content/en/docs/contributing/development-environment.md (1)
Line range hint
15-41: Add Rust version requirements and setup verification stepsSince Rust is being added as a requirement, it would be helpful to:
- Specify the minimum required Rust version
- Add verification steps for the Rust installation
Consider adding the following section after the package installation steps:
- Verify Rust installation: ```bash rustc --version # Should be 1.x.x or higher cargo --version</blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (3)</summary><blockquote> <details> <summary>site/content/en/docs/contributing/development-environment.md (3)</summary><blockquote> `15-15`: **Consider adding rustup for better Rust toolchain management** While `cargo` is included, consider recommending `rustup` for better Rust toolchain management. This would align with Rust's official installation recommendations. ```diff - sudo apt-get update && sudo apt-get --no-install-recommends install -y build-essential curl git redis-server python3-dev python3-pip python3-venv python3-tk libldap2-dev libsasl2-dev cargo + sudo apt-get update && sudo apt-get --no-install-recommends install -y build-essential curl git redis-server python3-dev python3-pip python3-venv python3-tk libldap2-dev libsasl2-dev + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
28-28: Ensure consistent Rust installation approach across OSMacOS uses
rustfrom Homebrew while Ubuntu usescargo. Consider usingrustupfor MacOS as well for consistency.- brew install git python pyenv redis curl openssl node sqlite3 geos rust + brew install git python pyenv redis curl openssl node sqlite3 geos + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
41-41: Align Rust installation with other OS instructionsArch Linux uses the system package manager for Rust. Consider using
rustuphere as well for consistency across all platforms.- sudo pacman -S base-devel curl git redis cmake gcc python python-pip tk libldap libsasl pkgconf ffmpeg geos openldap rust + sudo pacman -S base-devel curl git redis cmake gcc python python-pip tk libldap libsasl pkgconf ffmpeg geos openldap + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
site/content/en/docs/contributing/development-environment.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: generate_github_pages
- GitHub Check: Analyze (python)
- GitHub Check: Analyze (javascript)
- GitHub Check: Linter
Motivation and context
Rust is now among dependencies due to #8923
Adding it to docs
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit
cargoandrustpackages to installation dependencies for improved development environment configuration