fix: align CloudXR quick start requirements - #839
Conversation
Signed-off-by: Andrew Russell <arussell@nvidia.com>
📝 WalkthroughWalkthroughThe changes update Windows pre-commit guidance, clarify conditional Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/source/getting_started/build_from_source/index.rst (1)
43-53: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winMake the package installation conditional.
The text says Wi‑Fi users need neither package, but the only command unconditionally installs both
android-tools-adbandcoturn. Split this into mode-specific commands or clearly mark the command as applying only to USB-local/OOB setups.As per path instructions, this is a factual contradiction in the documented setup flow.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/source/getting_started/build_from_source/index.rst` around lines 43 - 53, The installation instructions contradict the Wi-Fi workflow by unconditionally installing android-tools-adb and coturn. Update the package-installation section to provide mode-specific commands or clearly scope each package to its required --setup-oob and --usb-local modes, leaving Wi-Fi users without either package.Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/source/getting_started/build_from_source/index.rst`:
- Around line 43-53: The installation instructions contradict the Wi-Fi workflow
by unconditionally installing android-tools-adb and coturn. Update the
package-installation section to provide mode-specific commands or clearly scope
each package to its required --setup-oob and --usb-local modes, leaving Wi-Fi
users without either package.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f1ce959a-a74a-4862-8ee0-477038444c25
📒 Files selected for processing (4)
AGENTS.mddocs/source/getting_started/build_from_source/index.rstdocs/source/getting_started/quick_start.rstexamples/cloudxr_mujoco_teleop/pyproject.toml
Signed-off-by: Andrew Russell <arussell@nvidia.com>
|
Addressed the package-installation review in |
Summary
adb/coturnrequirementsValidation
SKIP=check-copyright-year pre-commit run --all-files