Skip to content

docs: clarify web client panel behavior for camera viewing - #1298

Merged
farbod-nv merged 2 commits into
mainfrom
fm/docs-camera-client-ui
Oct 20, 2026
Merged

farbod-nv merged 2 commits into
mainfrom
fm/docs-camera-client-ui

Conversation

@farbod-nv

@farbod-nv farbod-nv commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Description

Addresses VDR feedback about the controls overlay obscuring the camera view.

Clarifies that the default web client displays connection information and controls useful during development. Documents selecting one of the Real Robot teleop applications to start with the panel hidden, and using Show/Hide to toggle it.

Updates the camera streaming guide, headset quickstart, and camera_viz README.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Testing

Validated on macOS:

  • SKIP=check-copyright-year pre-commit run --all-files — passed.
  • Sphinx documentation build via make current-docs, with warnings treated as errors — passed.
  • Verified the generated cross-references.

No runtime tests added because this change only updates documentation.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

Summary by CodeRabbit

  • Documentation
    • Added guidance for using the in-XR control panel when connecting through Meta Quest, PICO, or a browser.
    • Documented how to hide and reopen the control panel while viewing camera streams.
    • Added camera visualization web-client instructions, including access details and links to related guidance.

@farbod-nv farbod-nv self-assigned this Oct 20, 2026
@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 5afa90d9-c067-4c6b-8991-2e4d1e1bc0ef

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 725f11eb-dfb8-4b1a-a443-9fbfe8170a20
📥 Commits

Reviewing files that changed from the base of the PR and between 17a3eac and 8d7de2c.

📒 Files selected for processing: 3
  • docs/source/getting_started/quick_start.rst
  • docs/source/references/camera_streaming.rst
  • examples/camera_viz/README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Walkthrough

The documentation adds instructions for the default in-XR control panel in the headset quick start, camera streaming guide, and camera visualization README. It explains how to hide or reopen the panel and refers readers to headset connection steps.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to 8d7de

The documentation changes are consistent and do not introduce an actionable merge risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the documentation change to clarify web client panel behavior for camera viewing.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

✨ Finishing Touches: 💡 1
⚔️ Resolve merge conflicts: 💡
  • Resolve merge conflict in branch fm/docs-camera-client-ui
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Comment thread docs/source/getting_started/quick_start.rst Outdated
Signed-off-by: Farbod Motlagh <fmotlagh@nvidia.com>
Signed-off-by: Farbod Motlagh <fmotlagh@nvidia.com>
@farbod-nv
farbod-nv force-pushed the fm/docs-camera-client-ui branch from aba27cb to 8659ccf Compare October 20, 2026 20:25
@github-actions

Copy link
Copy Markdown
Contributor

✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1298/

Built from commit 8659ccf. It may take a minute for the updated preview to appear.

@farbod-nv
farbod-nv merged commit 0983fe7 into main Oct 20, 2026
39 checks passed
@farbod-nv
farbod-nv deleted the fm/docs-camera-client-ui branch October 20, 2026 21:20
github-actions Bot added a commit that referenced this pull request Oct 20, 2026
farbod-nv added a commit that referenced this pull request Oct 20, 2026
…1302)

* docs: clarify web client panel behavior for camera viewing



* docs: recommend the in-XR comfort setting to hide the panel



---------


(cherry picked from commit 0983fe7)

Signed-off-by: Farbod Motlagh <fmotlagh@nvidia.com>

This branch was successfully deployed

1 active deployment
dev — 8659ccf7 Deployed Oct 20, 2026 by farbod-nv via publish-wheel #5775
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants