Skip to content

Conversation

@lotusl-code
Copy link
Contributor

@lotusl-code lotusl-code commented Oct 23, 2025

Description

Adds a link to the DGX spark limitation section from XR teleop doc pages.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 23, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Overview

Greptile Summary

This PR adds documentation notes to two CloudXR teleoperation guide files, directing users to check DGX Spark compatibility limitations before setup. The notes are inserted in the System Requirements sections and link to the installation documentation where DGX Spark constraints are detailed.

PR Description Notes:

  • The PR description is incomplete - it still contains the template boilerplate without a proper summary of the change, no linked issue, and all checklist items remain unchecked.

Critical Issues

Hardcoded Version in Documentation Links

Both modified files (cloudxr_teleoperation_cluster.rst and cloudxr_teleoperation.rst) contain links that hardcode version 2.3.0:

`DGX Spark Limitations <https://isaac-sim.github.io/IsaacLab/release/2.3.0/source/setup/installation/index.html#dgx-spark-details-and-limitations>`_

This creates several problems:

  1. Version mismatch: When users view these docs from the main or develop branches, they will be redirected to version 2.3.0 docs, which may contain outdated or incorrect information.

  2. Link rot: If version 2.3.0 is eventually removed or reorganized, the links will break.

  3. Maintenance burden: Future versions will inherit these hardcoded links, requiring manual updates in each release.

The IsaacLab documentation appears to support multi-versioning (evidenced by sphinx-multiversion in dependencies and the _templates/versioning.html file). The links should use relative paths like:

:ref:`dgx-spark-details-and-limitations`

or version-agnostic paths that resolve to the current documentation context.

Confidence Score: 2/5

The hardcoded version links are a significant issue that will cause confusion and potentially break in the future. The change itself is simple, but the implementation needs correction before merging.

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@kellyguo11 kellyguo11 changed the title Add dgx spark limitations link to teleop docs Adds dgx spark limitations link to teleop docs Oct 23, 2025
@kellyguo11 kellyguo11 changed the base branch from main to release/2.3.0 October 23, 2025 04:01
@kellyguo11 kellyguo11 merged commit 9e28ec7 into isaac-sim:release/2.3.0 Oct 23, 2025
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants