Skip to content

fix: align CloudXR quick start requirements - #839

Open
arussell-nvidia wants to merge 2 commits into
mainfrom
codex/quick-start-qa-followup
Open

fix: align CloudXR quick start requirements#839
arussell-nvidia wants to merge 2 commits into
mainfrom
codex/quick-start-qa-followup

Conversation

@arussell-nvidia

@arussell-nvidia arussell-nvidia commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • clarify single-runtime, certificate-acceptance, and mode-specific adb/coturn requirements
  • declare the MuJoCo CloudXR example's WebSockets dependency
  • document Windows and sparse-checkout prerequisites for running the repository hook set

Validation

  • SKIP=check-copyright-year pre-commit run --all-files

Signed-off-by: Andrew Russell <arussell@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The changes update Windows pre-commit guidance, clarify conditional adb and coturn requirements, revise CloudXR installation and runtime instructions, and add certificate acceptance guidance. The CloudXR MuJoCo teleoperation example now declares websockets>=14 as a runtime dependency.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main CloudXR quick start requirements update and is concise enough for history scanning.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/quick-start-qa-followup

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 win

Make the package installation conditional.

The text says Wi‑Fi users need neither package, but the only command unconditionally installs both android-tools-adb and coturn. 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

📥 Commits

Reviewing files that changed from the base of the PR and between a3513b7 and 069336c.

📒 Files selected for processing (4)
  • AGENTS.md
  • docs/source/getting_started/build_from_source/index.rst
  • docs/source/getting_started/quick_start.rst
  • examples/cloudxr_mujoco_teleop/pyproject.toml

Signed-off-by: Andrew Russell <arussell@nvidia.com>
@arussell-nvidia

Copy link
Copy Markdown
Contributor Author

Addressed the package-installation review in c3e30a9c: the normal Wi-Fi path now has no runtime-package command, --setup-oob installs only adb, and --setup-oob --usb-local installs adb plus coturn. I also merged current main normally, preserving the version-aware install flow from #838 without force-pushing. The full pre-commit hook set passes on the merged result.

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