Skip to content

Add docs for building the WebXR client#371

Open
jiwenc-nv wants to merge 1 commit intoNVIDIA:mainfrom
jiwenc-nv:jiwenc/build-docs
Open

Add docs for building the WebXR client#371
jiwenc-nv wants to merge 1 commit intoNVIDIA:mainfrom
jiwenc-nv:jiwenc/build-docs

Conversation

@jiwenc-nv
Copy link
Copy Markdown
Collaborator

@jiwenc-nv jiwenc-nv commented Apr 8, 2026

Summary by CodeRabbit

  • Documentation

    • Added comprehensive build guide for the Isaac Teleop WebXR client, including prerequisites, setup instructions, and deployment options for development and HTTPS servers.
    • Updated documentation structure and cross-references to direct users to the new WebXR build documentation.
  • Chores

    • Updated CloudXR package dependency configuration.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 8, 2026

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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 434de791-19e8-4916-b578-8b4ca86502c6

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
📝 Walkthrough

Walkthrough

The PR updates dependency resolution for the CloudXR package and restructures the build documentation. The npm dependency in webxr_client/package.json now references a local tarball file instead of a dev specifier. Documentation pages are reorganized to include a dedicated WebXR build guide with setup instructions, prerequisites, and build commands, while cross-references throughout the docs are updated to point to the new structure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: comprehensive documentation was added for building the WebXR client, including a new RST guide and integration into the docs structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/source/getting_started/build_from_source/webxr.rst`:
- Around line 47-50: The note incorrectly references the --ignore-scripts flag
while the command "npm install ../nvidia-cloudxr-6.1.0.tgz && npm install" does
not include it; fix by either updating the command to "npm install
--ignore-scripts ../nvidia-cloudxr-6.1.0.tgz && npm install --ignore-scripts"
(to match the note) or remove the note entirely so it no longer mentions
--ignore-scripts; locate the snippet containing the command and the adjacent "..
note::" and apply one of these two changes consistently.
- Line 9: Fix the grammatical error in the sentence that currently reads "We
host a prebuilt CloudXR web client at
https://nvidia.github.io/IsaacTeleop/client/ for users don't need custom" by
updating it to "We host a prebuilt CloudXR web client at
https://nvidia.github.io/IsaacTeleop/client/ for users who don't need custom"
(replace the phrase "for users don't need" with "for users who don't need").
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: da16f835-fd71-4cda-80fc-a1ce928f41a7

📥 Commits

Reviewing files that changed from the base of the PR and between f420f71 and 2150fa7.

📒 Files selected for processing (5)
  • deps/cloudxr/webxr_client/package.json
  • docs/source/getting_started/build_from_source/index.rst
  • docs/source/getting_started/build_from_source/webxr.rst
  • docs/source/getting_started/quick_start.rst
  • docs/source/index.rst

Copy link
Copy Markdown
Contributor

@yanziz-nvidia yanziz-nvidia left a comment

Choose a reason for hiding this comment

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

lgtm modulo comments

@jiwenc-nv jiwenc-nv force-pushed the jiwenc/build-docs branch from 2150fa7 to 03e25aa Compare April 8, 2026 22:08
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.

2 participants