docs: trim quick start, fix section anchors, clarify nlopt build#681
Conversation
- Add explicit anchors to all steps so local TOC uses text-based hashes instead of auto-generated idXX anchors - Convert ARM64 nlopt note (step 2) to collapsible dropdown - Collapse CloudXR Configurations subsection into a dropdown; remove the orphaned bare code block that followed it - Rename step 5 Quest/Pico dropdown to mention desktop browser as a valid option; surface the --host-client note prominently instead of at the bottom - Move air-gapped/offline caching details into a nested dropdown - Explain WHY nlopt wheel needs matching Python version (CPython ABI-specific extension binary) - Fix hardcoded /main/ URL in egocentric_hand_reconstruction.rst with a proper :doc: cross-reference Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR updates documentation across the Isaac Teleop repository. The build-from-source guide clarifies that ARM64 nlopt wheels require an exact Python version match due to CPython ABI specificity. The quick start guide is restructured with labeled section anchors and dropdown-style blocks for advanced topics like CloudXR configuration, XR headset setup, and offline deployment. The OAK camera documentation link is converted to an internal Sphinx reference, and several environment variable tables and fallback instructions are reformatted for clarity. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@docs/source/getting_started/quick_start.rst`:
- Around line 211-213: The link target `nvidia.github.io/IsaacTeleop/client`_ is
missing a reference definition so Sphinx will render it broken; fix by replacing
the reference-style link with an inline external link (e.g.,
`https://nvidia.github.io/IsaacTeleop/client`) or add a corresponding reference
definition for `nvidia.github.io/IsaacTeleop/client`_ at the bottom of the
document; update the sentence that mentions IWER (Immersive Web Emulator
Runtime) to use the corrected inline URL or the new reference name so the
desktop-browser path resolves correctly.
🪄 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: Enterprise
Run ID: 07726b9d-52a1-4608-baee-47a4e2f974b6
📒 Files selected for processing (3)
docs/source/getting_started/build_from_source/index.rstdocs/source/getting_started/quick_start.rstdocs/source/references/egocentric_hand_reconstruction.rst
Replace the undefined `nvidia.github.io/IsaacTeleop/client`_ reference target with an inline anonymous hyperlink so Sphinx renders the desktop browser path correctly instead of generating a broken #idN anchor. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The default backlinks=entry wraps each section heading in a link back to its TOC entry (#id12, etc.). With backlinks=none the headings keep their own named anchor (#run-cloudxr-server, etc.). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary
.. _anchor:labels to all 7 steps so the local table of contents uses readable text hashes (#run-cloudxr-server,#whitelist-firewall-ports, etc.) instead of auto-generated#id1/#id2anchors--host-clientnote moved to the top of the sectionbuild_from_source/index.rst): explain why the venv Python version must match — nlopt builds a CPython ABI-specific extension binary, so 3.11 and 3.12 wheels are not interchangeableegocentric_hand_reconstruction.rst: replace hardcodedhttps://nvidia.github.io/IsaacTeleop/main/device/oak.htmlwith a proper:doc:cross-reference so it resolves correctly on all branches/versionsTest plan
#id1)--host-clientnote cross-links correctly to step 3 and step 4 anchors/device/oak🤖 Generated with Claude Code
Summary by CodeRabbit