Skip to content

docs: more touch up for GA#240

Merged
jiwenc-nv merged 3 commits intomainfrom
jiwenc/docs-enhancement
Mar 10, 2026
Merged

docs: more touch up for GA#240
jiwenc-nv merged 3 commits intomainfrom
jiwenc/docs-enhancement

Conversation

@jiwenc-nv
Copy link
Collaborator

@jiwenc-nv jiwenc-nv commented Mar 10, 2026

Summary by CodeRabbit

  • New Features

    • Added a documentation version switcher to navigate between doc versions.
  • Documentation

    • Improved build-from-source references and clarified workflow links.
    • Expanded Quick Start with CloudXR configuration options and device profiles.
    • Added headset-specific firewall/port guidance for Quest, Pico, and Vision Pro.
  • Style / UX

    • Refined version-switcher and sidebar search visuals, unified navigation color theming, and added per-version badge icons in the docs sidebar.

@coderabbitai
Copy link

coderabbitai bot commented Mar 10, 2026

📝 Walkthrough

Walkthrough

Adds a version switcher UI to the docs (template + CSS) and updates Sphinx config to support template-based versioning and per-version icons. Also refactors several getting-started docs for clearer references, environment examples, and new dropdown configuration sections.

Changes

Cohort / File(s) Summary
Version switcher UI
docs/source/_static/css/custom.css, docs/source/_templates/versioning.html
Adds .version-switcher styling and unified sidebar search styles; adds versioning.html template rendering a <select> populated from versions.branches and versions.tags with onchange navigation.
Sphinx configuration
docs/source/conf.py
Adds _templates to paths and exclude_patterns; introduces _smv_name, _DEFAULT_ICONS, _VERSION_ICON_MAP, and computed _icons; updates html_theme_options / icon_links, html_sidebars to include versioning.html, and sets html_context.github_version to _smv_name or "main".
Docs content: build instructions
docs/source/getting_started/build_from_source.rst
Replaces literal workflow links with :code-file: role references for CI files and minor wording adjustments.
Docs content: quick start & configs
docs/source/getting_started/quick_start.rst
Renames environment example to custom.env; adds Custom CloudXR configurations dropdown documenting NV_DEVICE_PROFILE and NV_CXR_ENABLE_PUSH_DEVICES; reorganizes Firewall/Ports and headset sections into dropdown blocks; updates web client path references from deps/cloudxr/webxr_client/ to cloudxr/webxr_client/.

Sequence Diagram(s)

sequenceDiagram
    participant User as Browser/User
    participant Template as versioning.html
    participant Sphinx as Build-time versions data

    Note over Sphinx,Template: Build generates template with versions list
    Sphinx->>Template: Embed versions.branches & versions.tags
    Template->>User: Render select dropdown with options
    User->>Template: Select option (onchange)
    Template->>User: location = selected option URL (navigate)
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Poem

🐰 I hopped through templates, CSS in paw,

A chooser blooms where versions draw,
Dropdowns, icons, and docs that sing,
Click once, and the right page will spring. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: more touch up for GA' uses the vague term 'touch up' which doesn't clearly convey specific changes, making it difficult for teammates to understand the primary changes from the title alone. Replace 'more touch up' with specific descriptions of the main changes, such as 'docs: add version switcher UI and update documentation formatting' or similar more descriptive phrasing.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jiwenc/docs-enhancement

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

Copy link

@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: 1

🤖 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 193-197: Update the tip text that references the
`nvidia.github.io/IsaacTeleop/client` URL to clarify IWER (Immersive Web
Emulator Runtime) requirements: state that IWER must be installed or enabled as
a browser extension or runtime for automatic emulation to work, and optionally
list which desktop browsers have built‑in WebXR emulation (or link to a
setup/installation doc) so users who don’t have IWER installed know they must
install/enable it before the Meta Quest 3 emulation will load.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: a6b268ad-cd1f-4b0d-ac85-5b2205c22e8a

📥 Commits

Reviewing files that changed from the base of the PR and between c5c32ed and 7745ff1.

⛔ Files ignored due to path filters (2)
  • docs/source/_static/cloudxr_accept_cert_isnt_working.png is excluded by !**/*.png
  • docs/source/_static/cloudxr_accept_cert_not_private.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • docs/source/_static/css/custom.css
  • docs/source/_templates/versioning.html
  • docs/source/conf.py
  • docs/source/getting_started/build_from_source.rst
  • docs/source/getting_started/quick_start.rst

@jiwenc-nv jiwenc-nv force-pushed the jiwenc/docs-enhancement branch from 7745ff1 to 5e1b771 Compare March 10, 2026 22:26
Copy link

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

♻️ Duplicate comments (1)
docs/source/getting_started/quick_start.rst (1)

193-197: ⚠️ Potential issue | 🟡 Minor

Clarify the IWER prerequisite in this tip.

This still reads as if Quest 3 emulation works automatically in any desktop browser. Please call out that IWER must already be installed/enabled, or link to the setup/support matrix, so users do not treat this as zero-setup validation.

Does Immersive Web Emulator Runtime (IWER) need to be installed or enabled in a desktop browser before it can emulate a Meta Quest 3 headset, and which desktop browsers have built-in WebXR emulation support?
🤖 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 193 - 197, Update
the tip text that mentions IWER and the `nvidia.github.io/IsaacTeleop/client`
URL to explicitly state that Immersive Web Emulator Runtime (IWER) must be
installed/enabled in the desktop browser before Quest 3 emulation will work, and
either add a link to the IWER setup/support matrix or list which desktop
browsers include WebXR/IWER emulation support; locate and edit the tip block
referencing IWER and the client URL to append the prerequisite and link or
browser list so readers aren’t misled into thinking no setup is required.
🤖 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 193-197: Update the tip text that mentions IWER and the
`nvidia.github.io/IsaacTeleop/client` URL to explicitly state that Immersive Web
Emulator Runtime (IWER) must be installed/enabled in the desktop browser before
Quest 3 emulation will work, and either add a link to the IWER setup/support
matrix or list which desktop browsers include WebXR/IWER emulation support;
locate and edit the tip block referencing IWER and the client URL to append the
prerequisite and link or browser list so readers aren’t misled into thinking no
setup is required.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ec7b4554-a1ab-49a2-9a13-38bd97222338

📥 Commits

Reviewing files that changed from the base of the PR and between 7745ff1 and 5e1b771.

⛔ Files ignored due to path filters (2)
  • docs/source/_static/cloudxr_accept_cert_isnt_working.png is excluded by !**/*.png
  • docs/source/_static/cloudxr_accept_cert_not_private.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • docs/source/_static/css/custom.css
  • docs/source/getting_started/quick_start.rst

@jiwenc-nv jiwenc-nv merged commit 61fdd77 into main Mar 10, 2026
37 checks passed
@jiwenc-nv jiwenc-nv deleted the jiwenc/docs-enhancement branch March 10, 2026 23:46
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