Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughReworks and expands documentation across device plugins, trackers, TeleopSession API, getting-started and build-from-source guides; adds Sphinx roles and link behavior; adjusts CSS; removes several README files and an Isaac Lab run script; updates examples and retargeting docs and index toctrees. Changes
Sequence Diagram(s)mermaid Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
jiwenc-nv
force-pushed
the
jiwenc/docs-quickstart
branch
2 times, most recently
from
9abec13 to
609b221
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 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/_static/css/custom.css`:
- Around line 68-75: The global removal of underlines on the a selector harms
accessibility; change the rule so it only targets navigation or decorative links
(e.g., replace the global a selector with a more specific selector such as nav a
or a.no-underline) and retain underlines for body text links, and ensure focus
styles remain highly visible (keep a:focus and a:hover underline or an
equivalent visible focus indicator for keyboard users) so functions like the a,
a:hover, a:focus selectors are adjusted accordingly.
In `@docs/source/device/add_device.rst`:
- Around line 142-143: The cross-reference direction is wrong: change the phrase
that reads ":ref:`Schema IO example: build and run <schema-io-example>` above
for building and running ``pedal_pusher`` and ``pedal_printer``." to say "below"
instead of "above" so the sentence correctly references the :ref: target
"schema-io-example" which is defined below; update the text containing the
literal strings "schema-io-example", "pedal_pusher", and "pedal_printer"
accordingly.
In `@docs/source/device/trackers.rst`:
- Around line 33-38: Fix the typos in the documentation note: change
"considerred" to "considered" and "practive" to "practice" in the sentence
referencing the DeviceIOSession and the :doc:`../getting_started/teleop_session`
so the note reads that DeviceIOSession is considered a low level API and in
practice it is recommended to use the teleop_session to manage a teleop session
with multiple device trackers and retargeters.
In `@docs/source/getting_started/quick_start.rst`:
- Line 99: Fix the typo in the documentation string "or insetall a separate
client." by replacing "insetall" with "install" so the sentence reads "or
install a separate client."; locate the exact phrase "or insetall a separate
client." in the quick start doc and update it to "or install a separate client."
- Line 210: The file ends without a trailing newline which breaks the
end-of-file-fixer hook; open the docs/source/getting_started/quick_start.rst and
add a single newline at the end of the file (after the line containing the link
label "`CloudXR teleoperation in Isaac Lab`:
https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html")
so the file ends with a newline character.
- Around line 123-126: Remove the duplicated sentence "for more details if you
want to run the web client from source" in the quick start doc: keep a single
instance of that clause (immediately after the CloudXR.js documentation
reference) and delete the redundant repeat so the paragraph reads once,
preserving surrounding punctuation and capitalization.
In `@docs/source/references/retargeting.rst`:
- Around line 124-126: Replace the hard-coded GitHub URL that uses "blob/main"
(e.g. the string
"https://github.com/NVIDIA/IsaacTeleop/blob/main/src/retargeters/README.md"
referenced in this file) with either a relative/local docs page link or a
branch/tag-aware URL (for example using the release tag placeholder or a
variable that the docs build injects) so the referenced example stays
version-locked to the docs; update each occurrence (the three links currently
pointing to blob/main) to use the chosen approach and ensure the link target
exists in the docs or repository for that release.
In `@examples/teleop_session_manager/python/README.md`:
- Line 39: Update the README.md documentation reference: replace the incorrect
path string "docs/source/references/teleop_session.rst" with the correct module
doc path "docs/source/getting_started/teleop_session.rst" so the README points
to the actual teleop_session documentation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 11de9ac1-0479-4999-9b1f-2c804c67bc83
⛔ Files ignored due to path filters (1)
docs/source/_static/cloudxr-web-client-howto.pngis excluded by!**/*.png
📒 Files selected for processing (16)
README.mddocs/source/_static/css/custom.cssdocs/source/conf.pydocs/source/device/add_device.rstdocs/source/device/index.rstdocs/source/device/trackers.rstdocs/source/getting_started/quick_start.rstdocs/source/getting_started/teleop_session.rstdocs/source/index.rstdocs/source/overview/ecosystem.rstdocs/source/references/device.rstdocs/source/references/retargeting.rstexamples/schemaio/CMakeLists.txtexamples/schemaio/README.mdexamples/teleop_session_manager/python/README.mdsrc/core/teleop_session_manager/README.md
💤 Files with no reviewable changes (4)
- src/core/teleop_session_manager/README.md
- docs/source/references/device.rst
- examples/schemaio/README.md
- README.md
There was a problem hiding this comment.
♻️ Duplicate comments (3)
docs/source/getting_started/quick_start.rst (3)
123-125:⚠️ Potential issue | 🟡 MinorRemove duplicate sentence fragment.
Lines 124-125 repeat the phrase "for more details if you want to run the web client from source."
📝 Proposed fix
The source code for the web client is in the :code-dir:`deps/cloudxr/webxr_client/` directory. Follow -the instructions in the official `CloudXR.js documentation`_ for more details if you want to run the web client from source. -for more details if you want to run the web client from source. +the instructions in the official `CloudXR.js documentation`_ for more details if you want to run the web client from source.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` around lines 123 - 125, Remove the duplicated sentence fragment "for more details if you want to run the web client from source." from the quick start paragraph so it appears only once; locate the paragraph that mentions ":code-dir:`deps/cloudxr/webxr_client/`" and the CloudXR.js documentation and delete the repeated trailing phrase so the sentence reads cleanly without repetition.
99-99:⚠️ Potential issue | 🟡 MinorFix typo: "insetall" → "install".
The typo from the previous review remains unfixed.
📝 Proposed fix
-or insetall a separate client. +or install a separate client.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 99, Replace the misspelled word "insetall" with "install" in the sentence containing the phrase "or insetall a separate client." so it reads "or install a separate client."; update the single occurrence in the quick start docs entry to correct the typo.
210-210:⚠️ Potential issue | 🟡 MinorAdd missing newline at end of file.
The pipeline failure from the previous review indicated this file is missing a trailing newline, which is required by the
end-of-file-fixerpre-commit hook.📝 Proposed fix
.. _`CloudXR teleoperation in Isaac Lab`: https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html +🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 210, The file ends with the line ".. _`CloudXR teleoperation in Isaac Lab`: https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html" but is missing a trailing newline; open the file containing that anchor line and add a single newline character at the end of file so the `end-of-file-fixer` pre-commit hook passes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/source/getting_started/quick_start.rst`:
- Around line 123-125: Remove the duplicated sentence fragment "for more details
if you want to run the web client from source." from the quick start paragraph
so it appears only once; locate the paragraph that mentions
":code-dir:`deps/cloudxr/webxr_client/`" and the CloudXR.js documentation and
delete the repeated trailing phrase so the sentence reads cleanly without
repetition.
- Line 99: Replace the misspelled word "insetall" with "install" in the sentence
containing the phrase "or insetall a separate client." so it reads "or install a
separate client."; update the single occurrence in the quick start docs entry to
correct the typo.
- Line 210: The file ends with the line ".. _`CloudXR teleoperation in Isaac
Lab`:
https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html"
but is missing a trailing newline; open the file containing that anchor line and
add a single newline character at the end of file so the `end-of-file-fixer`
pre-commit hook passes.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: f97e2926-9a30-481b-8a2c-d961881286a4
⛔ Files ignored due to path filters (1)
docs/source/_static/cloudxr-web-client-howto.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/source/getting_started/quick_start.rst
jiwenc-nv
force-pushed
the
jiwenc/docs-quickstart
branch
from
609b221 to
7b0fa9c
Compare
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 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/quick_start.rst`:
- Around line 106-107: Correct the typo "Vision Pro cilent" to "Vision Pro
client" in the Quick Start text that references `CloudXR network setup`; update
the wording in the sentence mentioning running the CloudXR runtime and wss proxy
in containerized environments or using the Vision Pro client so the term
"client" is spelled correctly.
- Around line 117-120: Update the wording in the sentence that currently reads
"You can just open this URL in your headset's browser to connect to your
headset" so it correctly states that the headset browser connects to the
workstation running CloudXR (e.g., "to connect the headset to the workstation
running CloudXR"); also fix the typo "insetall" to "install" in the same
paragraph. Locate and edit the sentence in the quick_start.rst paragraph that
references the hosted CloudXR client URL (nvidia.github.io/IsaacTeleop/client)
to make these wording and spelling corrections.
In `@docs/source/overview/ecosystem.rst`:
- Around line 64-75: Replace the hardcoded "Q2 2026" ETA in the "Planned Input
Devices" list-table: locate the table titled "Planned Input Devices" and the row
with "Keyboard and Mouse" and change the ETA cell to a non-timebound value such
as "TBD" or "Planned" (or replace it with a link to a maintainable roadmap page)
so the docs don't contain a stale fixed date.
- Around line 82-84: The three external links labeled "Manus Gloves Plugin",
"Generic 3-axis Pedal Plugin", and "OAK-D Camera Plugin" use hardcoded tree/main
URLs which are not version-stable; update each link in ecosystem.rst to use
either a Sphinx internal reference (e.g., :ref:`manus-gloves-plugin` or the
appropriate doc page name) or a version-aware source link (pointing to a
release/tag instead of tree/main or using a build variable that inserts the
current docs version), replacing the existing URLs so published docs always
reference the correct versioned plugin paths.
In `@README.md`:
- Around line 135-137: Fix the broken handoff paragraph by correcting the typos
and completing the trailing sentence: replace "Isaac Tepeop Core is design" with
"Isaac Tepeop Core is designed" and ensure the second sentence reads something
like "Then follow the CloudXR teleoperation in Isaac Lab guide to get started
with teleoperation." Update the fragment "Teleoperation in ." to a complete
phrase ("teleoperation" or "teleoperation in Isaac Lab") and verify the link
text around "CloudXR teleoperation in Isaac Lab" remains intact and points to
the provided URL.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 23113417-bfe7-43c8-b7d1-b780d575c46c
⛔ Files ignored due to path filters (1)
docs/source/_static/cloudxr-web-client-howto.pngis excluded by!**/*.png
📒 Files selected for processing (5)
README.mddocs/source/getting_started/build_from_source.rstdocs/source/getting_started/quick_start.rstdocs/source/overview/ecosystem.rstscripts/run_isaac_lab.sh
💤 Files with no reviewable changes (1)
- scripts/run_isaac_lab.sh
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (5)
docs/source/getting_started/quick_start.rst (4)
133-134:⚠️ Potential issue | 🟡 MinorFix confusing wording and typo.
Line 133 incorrectly states the headset connects "to your headset" when it should say it connects to the workstation. Line 134 contains the typo "insetall" instead of "install".
📝 Proposed fix
-You can just open this URL in your headset's browser to connect to your headset. No need to build -or insetall a separate client. +You can just open this URL in your headset's browser to connect to the workstation running CloudXR. No need to build +or install a separate client.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` around lines 133 - 134, Update the sentence containing "open this URL in your headset's browser to connect to your headset" to clarify that the headset connects to the workstation (e.g., replace "to your headset" with "to the workstation"), and correct the typo "insetall" to "install" in the same paragraph (search for the fragment "open this URL in your headset's browser" to locate the text).
121-121:⚠️ Potential issue | 🟡 MinorFix typo: "cilent" → "client".
Line 121 contains a typo in "Vision Pro cilent".
📝 Proposed fix
-running the CloudXR runtime and wss proxy in containerized environment; or using Vision Pro cilent). +running the CloudXR runtime and wss proxy in containerized environment; or using Vision Pro client).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 121, Fix the typo "Vision Pro cilent" by replacing "cilent" with "client" wherever it appears (specifically update the sentence containing "Vision Pro cilent" in the quick start text), e.g., change "Vision Pro cilent" to "Vision Pro client" to correct the spelling in the documentation string.
159-160:⚠️ Potential issue | 🟡 MinorRemove duplicate sentence.
The phrase "for more details if you want to run the web client from source" appears twice consecutively.
📝 Proposed fix
The source code for the web client is in the :code-dir:`deps/cloudxr/webxr_client/` directory. Follow -the instructions in the official `CloudXR.js documentation`_ for more details if you want to run the web client from source. -for more details if you want to run the web client from source. +the instructions in the official `CloudXR.js documentation`_ for more details if you want to run the web client from source.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` around lines 159 - 160, Remove the duplicated sentence "for more details if you want to run the web client from source" so it appears only once (keep the instance that follows the CloudXR.js documentation reference), ensuring surrounding punctuation/spacing remains correct; search for the exact phrase to locate and delete the redundant line in the quick_start content.
246-246:⚠️ Potential issue | 🟡 MinorAdd missing newline at end of file.
The file must end with a newline character to satisfy the
end-of-file-fixerpre-commit hook.📝 Proposed fix
.. _`CloudXR teleoperation in Isaac Lab`: https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html +🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 246, Add a missing newline at end of file: ensure the last line containing ".. _`CloudXR network setup`: https://docs.nvidia.com/cloudxr-sdk/latest/requirement/network_setup.html#ports-and-firewalls" is terminated with a single newline character so the file ends with a newline to satisfy the end-of-file-fixer pre-commit hook.README.md (1)
93-95:⚠️ Potential issue | 🟡 MinorFix typos and complete the incomplete sentence.
Line 93 contains "Isaac Tepeop Core is design" (should be "designed"), and line 95 ends with the incomplete fragment "Teleoperation in ."
📝 Proposed fix
-Isaac Tepeop Core is design to work side by side with [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) starting with Isaac Lab 3.0 EA release. +Isaac Teleop Core is designed to work side by side with [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) starting with the Isaac Lab 3.0 EA release. -To get started, please refer to Isaac Lab's [Installation](https://isaac-sim.github.io/IsaacLab/main/source/setup/installation/index.html) guide for more details. Then follow the [CloudXR teleoperation in Isaac Lab](https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html) to get started with Teleoperation in . +To get started, please refer to Isaac Lab's [Installation](https://isaac-sim.github.io/IsaacLab/main/source/setup/installation/index.html) guide for more details. Then follow the [CloudXR teleoperation in Isaac Lab](https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html) guide to get started with teleoperation in Isaac Lab.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 93 - 95, Fix the typos and complete the unfinished sentence in the README: change "Isaac Tepeop Core is design" to "Isaac Teleop Core is designed" (correct project name to "Isaac Teleop Core" and verb to "designed") and finish the final sentence so the link reads "...to get started with Teleoperation in Isaac Teleop Core." Update the two occurrences in the README.md block around the Isaac Lab links (the sentence that introduces the project and the final sentence that ends with "Teleoperation in .") so both spelling and the incomplete fragment are corrected.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 45: Update the sentence "Teleoperate using only non-XR devices (e.g.
gamepad, Gello, haply, etc)" by adding a period after "etc" so it reads
"Teleoperate using only non-XR devices (e.g. gamepad, Gello, haply, etc.)."
Locate the exact string in README.md and replace the old punctuation
accordingly.
---
Duplicate comments:
In `@docs/source/getting_started/quick_start.rst`:
- Around line 133-134: Update the sentence containing "open this URL in your
headset's browser to connect to your headset" to clarify that the headset
connects to the workstation (e.g., replace "to your headset" with "to the
workstation"), and correct the typo "insetall" to "install" in the same
paragraph (search for the fragment "open this URL in your headset's browser" to
locate the text).
- Line 121: Fix the typo "Vision Pro cilent" by replacing "cilent" with "client"
wherever it appears (specifically update the sentence containing "Vision Pro
cilent" in the quick start text), e.g., change "Vision Pro cilent" to "Vision
Pro client" to correct the spelling in the documentation string.
- Around line 159-160: Remove the duplicated sentence "for more details if you
want to run the web client from source" so it appears only once (keep the
instance that follows the CloudXR.js documentation reference), ensuring
surrounding punctuation/spacing remains correct; search for the exact phrase to
locate and delete the redundant line in the quick_start content.
- Line 246: Add a missing newline at end of file: ensure the last line
containing ".. _`CloudXR network setup`:
https://docs.nvidia.com/cloudxr-sdk/latest/requirement/network_setup.html#ports-and-firewalls"
is terminated with a single newline character so the file ends with a newline to
satisfy the end-of-file-fixer pre-commit hook.
In `@README.md`:
- Around line 93-95: Fix the typos and complete the unfinished sentence in the
README: change "Isaac Tepeop Core is design" to "Isaac Teleop Core is designed"
(correct project name to "Isaac Teleop Core" and verb to "designed") and finish
the final sentence so the link reads "...to get started with Teleoperation in
Isaac Teleop Core." Update the two occurrences in the README.md block around the
Isaac Lab links (the sentence that introduces the project and the final sentence
that ends with "Teleoperation in .") so both spelling and the incomplete
fragment are corrected.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: c5bb840f-e18c-4d20-8bb9-0c2017d98363
📒 Files selected for processing (2)
README.mddocs/source/getting_started/quick_start.rst
jiwenc-nv
force-pushed
the
jiwenc/docs-quickstart
branch
2 times, most recently
from
dbabee3 to
9fbb75b
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (9)
README.md (2)
45-45:⚠️ Potential issue | 🟡 MinorAdd period after "etc" for American English style.
In American English, the abbreviation "etc" requires a period.
📝 Proposed fix
- - Teleoperate using only non-XR devices (e.g. gamepad, Gello, haply, etc) + - Teleoperate using only non-XR devices (e.g. gamepad, Gello, haply, etc.)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 45, Edit the README sentence "Teleoperate using only non-XR devices (e.g. gamepad, Gello, haply, etc)" to follow American English style by adding a period after "etc" so it reads "... etc."—locate and update that exact string in the README to include the trailing period.
74-76:⚠️ Potential issue | 🟡 MinorFix typos and complete the Isaac Lab handoff paragraph.
Multiple issues in the Isaac Lab integration paragraph:
- Line 74: "Tepeop" should be "Teleop"
- Line 74: "design" should be "designed"
- Line 76: Incomplete sentence ends with "Teleoperation in ."
📝 Proposed fix
-Isaac Tepeop Core is design to work side by side with [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) starting with Isaac Lab 3.0 EA release. +Isaac Teleop Core is designed to work side by side with [NVIDIA Isaac Lab](https://github.com/isaac-sim/IsaacLab) starting with the Isaac Lab 3.0 EA release. -To get started, please refer to Isaac Lab's [Installation](https://isaac-sim.github.io/IsaacLab/main/source/setup/installation/index.html) guide for more details. Then follow the [CloudXR teleoperation in Isaac Lab](https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html) to get started with Teleoperation in . +To get started, please refer to Isaac Lab's [Installation](https://isaac-sim.github.io/IsaacLab/main/source/setup/installation/index.html) guide for more details. Then follow the [CloudXR teleoperation in Isaac Lab](https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html) guide to get started with teleoperation in Isaac Lab.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 74 - 76, Fix the typos in the Isaac Lab integration paragraph: change "Isaac Tepeop Core" to "Isaac Teleop Core" and "design" to "designed", and complete the trailing sentence that reads "to get started with Teleoperation in ." by referencing Isaac Lab explicitly (e.g., "then follow the CloudXR teleoperation in Isaac Lab guide to get started with Teleoperation in Isaac Lab"). Use the existing phrases "Isaac Teleop Core" and "CloudXR teleoperation in Isaac Lab" to locate and update the paragraph.docs/source/getting_started/quick_start.rst (5)
134-134:⚠️ Potential issue | 🟡 MinorFix typo: "insetall" → "install".
Line 134 contains a typo in "or insetall a separate client."
📝 Proposed fix
-or insetall a separate client. +or install a separate client.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 134, Replace the typo "insetall" with "install" in the sentence containing "or insetall a separate client." so the text reads "or install a separate client."; update that exact token in the sentence to correct spelling (search for the string "or insetall a separate client." to locate the occurrence).
159-160:⚠️ Potential issue | 🟡 MinorRemove duplicate sentence.
Lines 159-160 contain duplicate text: "for more details if you want to run the web client from source" appears twice.
📝 Proposed fix
The source code for the web client is in the :code-dir:`deps/cloudxr/webxr_client/` directory. Follow -the instructions in the official `CloudXR.js documentation`_ for more details if you want to run the web client from source. -for more details if you want to run the web client from source. +the instructions in the official `CloudXR.js documentation`_ for more details if you want to run the web client from source.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` around lines 159 - 160, Remove the duplicated sentence "for more details if you want to run the web client from source" in the docs content: locate the repeated phrase in the quick_start.rst around the CloudXR.js documentation sentence and delete the redundant duplicate so the paragraph reads only once and punctuation/spacing remains correct.
246-246:⚠️ Potential issue | 🟡 MinorAdd missing newline at end of file.
The file should end with a newline character, as required by the
end-of-file-fixerpre-commit hook.📝 Proposed fix
.. _`CloudXR teleoperation in Isaac Lab`: https://isaac-sim.github.io/IsaacLab/main/source/how-to/cloudxr_teleoperation.html +🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 246, Add a trailing newline character at the end of the file containing the line beginning with ".. _`CloudXR network setup`: https://docs.nvidia.com/cloudxr-sdk/latest/requirement/network_setup.html#ports-and-firewalls" so the file ends with a single newline (satisfying the end-of-file-fixer pre-commit hook).
121-121:⚠️ Potential issue | 🟡 MinorFix typo: "cilent" → "client".
Line 121 contains a typo in "Vision Pro cilent".
📝 Proposed fix
-running the CloudXR runtime and wss proxy in containerized environment; or using Vision Pro cilent). +running the CloudXR runtime and wss proxy in containerized environment; or using Vision Pro client).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` at line 121, Replace the misspelled word "cilent" with "client" in the Quick Start text where the phrase "Vision Pro cilent" appears (in docs/source/getting_started/quick_start.rst); update the sentence to read "Vision Pro client" so the documentation no longer contains the typo.
133-134:⚠️ Potential issue | 🟡 MinorFix the connection target wording.
Line 133 says "to connect to your headset," but this step actually connects the headset browser to the workstation running CloudXR. The current wording is confusing for first-time setup.
📝 Proposed fix
-You can just open this URL in your headset's browser to connect to your headset. No need to build -or insetall a separate client. +Open this URL in your headset's browser to connect to the workstation running CloudXR. No need to +build or install a separate client.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/getting_started/quick_start.rst` around lines 133 - 134, The sentence fragment "to connect to your headset" is misleading—update the wording so it clearly states that the headset's browser is connecting to the workstation running CloudXR; replace the line containing "to connect to your headset" with something like "to open in your headset's browser and connect the headset's browser to the workstation running CloudXR" (or similar) so first-time users understand the direction of the connection.docs/source/overview/ecosystem.rst (2)
131-133:⚠️ Potential issue | 🟡 MinorUse version-stable docs links instead of
tree/main.These plugin links (Manus Gloves, Generic 3-axis Pedal, OAK-D Camera) always resolve to the repository's
mainbranch, so older published docs can send readers to plugin paths that no longer match the version they're reading. Prefer internal Sphinx refs or version-aware source links (pointing to a release/tag).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/overview/ecosystem.rst` around lines 131 - 133, Update the three hardcoded "tree/main" links for the Manus Gloves Plugin, Generic 3-axis Pedal Plugin, and OAK-D Camera Plugin so they are version-stable: replace the raw GitHub "tree/main" URLs with either internal Sphinx cross-reference targets (e.g., :ref: or reference roles pointing to local doc pages for these plugins) or construct GitHub URLs that point to the current release tag (not "main") using the project's version variable, ensuring the links resolve to the same tag/version as the docs being built.
31-31:⚠️ Potential issue | 🟡 MinorAvoid publishing hardcoded support ETAs.
The hardcoded "Q2 2026" entries at lines 31, 34, 107, and 111 will become stale quickly and can mislead users if schedules change. For GA docs, prefer "TBD", "Planned", or link to a roadmap page that can be updated independently.
Also applies to: 34-34, 107-107, 111-111
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/source/overview/ecosystem.rst` at line 31, Replace the hardcoded "Q2 2026" occurrences in the document (the literal string "Q2 2026") with a non-timebound placeholder such as "TBD" or "Planned", or replace them with a link to a maintained roadmap page; update each occurrence (including the duplicates) so the docs don't contain stale fixed ETAs and ensure the placeholder or link includes brief context about where users can find the authoritative schedule.
🤖 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/references/requirements.rst`:
- Line 19: Update the CPU model string to use AMD's official capitalization:
replace the literal "**CPU**: AMD Ryzen Threadripper 7960x (Recommended)" with
"**CPU**: AMD Ryzen Threadripper 7960X (Recommended)" so the trailing model
character is an uppercase "X" (change the "7960x" token to "7960X").
- Line 12: Update the CPU architecture capitalization in the documented
requirement string "**CPU**: X86 or ARM (Jetson Thor)" by replacing "X86" with
the correct technical notation (e.g., "x86" or "x86_64" for 64-bit), so the line
reads something like "**CPU**: x86 or ARM (Jetson Thor)" or "**CPU**: x86_64 or
ARM (Jetson Thor)" depending on the intended precision.
---
Duplicate comments:
In `@docs/source/getting_started/quick_start.rst`:
- Line 134: Replace the typo "insetall" with "install" in the sentence
containing "or insetall a separate client." so the text reads "or install a
separate client."; update that exact token in the sentence to correct spelling
(search for the string "or insetall a separate client." to locate the
occurrence).
- Around line 159-160: Remove the duplicated sentence "for more details if you
want to run the web client from source" in the docs content: locate the repeated
phrase in the quick_start.rst around the CloudXR.js documentation sentence and
delete the redundant duplicate so the paragraph reads only once and
punctuation/spacing remains correct.
- Line 246: Add a trailing newline character at the end of the file containing
the line beginning with ".. _`CloudXR network setup`:
https://docs.nvidia.com/cloudxr-sdk/latest/requirement/network_setup.html#ports-and-firewalls"
so the file ends with a single newline (satisfying the end-of-file-fixer
pre-commit hook).
- Line 121: Replace the misspelled word "cilent" with "client" in the Quick
Start text where the phrase "Vision Pro cilent" appears (in
docs/source/getting_started/quick_start.rst); update the sentence to read
"Vision Pro client" so the documentation no longer contains the typo.
- Around line 133-134: The sentence fragment "to connect to your headset" is
misleading—update the wording so it clearly states that the headset's browser is
connecting to the workstation running CloudXR; replace the line containing "to
connect to your headset" with something like "to open in your headset's browser
and connect the headset's browser to the workstation running CloudXR" (or
similar) so first-time users understand the direction of the connection.
In `@docs/source/overview/ecosystem.rst`:
- Around line 131-133: Update the three hardcoded "tree/main" links for the
Manus Gloves Plugin, Generic 3-axis Pedal Plugin, and OAK-D Camera Plugin so
they are version-stable: replace the raw GitHub "tree/main" URLs with either
internal Sphinx cross-reference targets (e.g., :ref: or reference roles pointing
to local doc pages for these plugins) or construct GitHub URLs that point to the
current release tag (not "main") using the project's version variable, ensuring
the links resolve to the same tag/version as the docs being built.
- Line 31: Replace the hardcoded "Q2 2026" occurrences in the document (the
literal string "Q2 2026") with a non-timebound placeholder such as "TBD" or
"Planned", or replace them with a link to a maintained roadmap page; update each
occurrence (including the duplicates) so the docs don't contain stale fixed ETAs
and ensure the placeholder or link includes brief context about where users can
find the authoritative schedule.
In `@README.md`:
- Line 45: Edit the README sentence "Teleoperate using only non-XR devices (e.g.
gamepad, Gello, haply, etc)" to follow American English style by adding a period
after "etc" so it reads "... etc."—locate and update that exact string in the
README to include the trailing period.
- Around line 74-76: Fix the typos in the Isaac Lab integration paragraph:
change "Isaac Tepeop Core" to "Isaac Teleop Core" and "design" to "designed",
and complete the trailing sentence that reads "to get started with Teleoperation
in ." by referencing Isaac Lab explicitly (e.g., "then follow the CloudXR
teleoperation in Isaac Lab guide to get started with Teleoperation in Isaac
Lab"). Use the existing phrases "Isaac Teleop Core" and "CloudXR teleoperation
in Isaac Lab" to locate and update the paragraph.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 99ca602c-0841-4e01-8ad2-44fc2d19fd09
⛔ Files ignored due to path filters (1)
docs/source/_static/cloudxr-web-client-howto.pngis excluded by!**/*.png
📒 Files selected for processing (7)
README.mddocs/source/getting_started/build_from_source.rstdocs/source/getting_started/quick_start.rstdocs/source/index.rstdocs/source/overview/ecosystem.rstdocs/source/references/requirements.rstscripts/run_isaac_lab.sh
💤 Files with no reviewable changes (1)
- scripts/run_isaac_lab.sh
jiwenc-nv
force-pushed
the
jiwenc/docs-quickstart
branch
from
9fbb75b to
69af0c5
Compare
jiwenc-nv
force-pushed
the
jiwenc/docs-quickstart
branch
from
33b71af to
6310b68
Compare
Will revive once it got publicly announced
jiwenc-nv
force-pushed
the
jiwenc/docs-quickstart
branch
from
6310b68 to
4a7f24f
Compare
rwiltz
approved these changes
Mar 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation
Style