Skip to content

docs: trim quick start, fix section anchors, clarify nlopt build#681

Merged
yanziz-nvidia merged 3 commits into
mainfrom
yanziz/docs-quick-start
Jun 13, 2026
Merged

docs: trim quick start, fix section anchors, clarify nlopt build#681
yanziz-nvidia merged 3 commits into
mainfrom
yanziz/docs-quick-start

Conversation

@yanziz-nvidia

@yanziz-nvidia yanziz-nvidia commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fix section ID links: add explicit .. _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/#id2 anchors
  • Step 2 ARM64 note → collapsible dropdown: x86_64 users no longer have to scroll past ARM64-specific content
  • Collapse CloudXR Configurations (step 3 subsection) into a dropdown; remove the orphaned stale code block that followed it
  • Step 5 Quest/Pico dropdown: renamed to "Meta Quest, PICO headset, or desktop browser" and restructured so the browser/IWER option leads rather than being buried in a tip; --host-client note moved to the top of the section
  • Air-gapped/offline caching details moved into a nested dropdown (further reduces visual noise on the happy path)
  • nlopt build comment (build_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 interchangeable
  • egocentric_hand_reconstruction.rst: replace hardcoded https://nvidia.github.io/IsaacTeleop/main/device/oak.html with a proper :doc: cross-reference so it resolves correctly on all branches/versions

Test plan

  • Verify rendered quick_start page TOC links all use text-based anchors (no #id1)
  • Confirm ARM64 dropdown and CloudXR configurations dropdown are collapsed by default
  • Confirm step 5 dropdown leads with the browser/IWER option
  • Confirm --host-client note cross-links correctly to step 3 and step 4 anchors
  • Spot-check egocentric_hand_reconstruction page: OAK link resolves to /device/oak

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Reorganized Quick Start guide with improved formatting and dropdown menus for clearer navigation
    • Clarified ARM64 build requirements regarding Python version compatibility
    • Enhanced internal cross-references between documentation sections
    • Updated guidance for XR headset configuration and offline deployment scenarios

- 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>
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

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

Review profile: CHILL

Plan: Enterprise

Run ID: ebd95227-9bda-4902-b0d6-f321870e5ef9

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

This 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)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the three main changes: documentation trimming, section anchor fixes, and nlopt build clarification—all of which are reflected in the actual file modifications.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch yanziz/docs-quick-start

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

@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.

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

📥 Commits

Reviewing files that changed from the base of the PR and between b212cfb and 402b549.

📒 Files selected for processing (3)
  • docs/source/getting_started/build_from_source/index.rst
  • docs/source/getting_started/quick_start.rst
  • docs/source/references/egocentric_hand_reconstruction.rst

Comment thread docs/source/getting_started/quick_start.rst Outdated
@yanziz-nvidia yanziz-nvidia enabled auto-merge (squash) June 13, 2026 06:06
@yanziz-nvidia yanziz-nvidia disabled auto-merge June 13, 2026 06:08
yanziz-nvidia and others added 2 commits June 12, 2026 23:08
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>
@yanziz-nvidia yanziz-nvidia enabled auto-merge (squash) June 13, 2026 06:25
@yanziz-nvidia yanziz-nvidia merged commit 64af477 into main Jun 13, 2026
48 checks passed
@yanziz-nvidia yanziz-nvidia deleted the yanziz/docs-quick-start branch June 13, 2026 06:47
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