Skip to content

Updating docs, explicitly call out physicx support and handtracking r…#5494

Merged
rwiltz merged 1 commit intoisaac-sim:developfrom
rwiltz:rwiltz/update-docs-physicx-handtarcking
May 5, 2026
Merged

Updating docs, explicitly call out physicx support and handtracking r…#5494
rwiltz merged 1 commit intoisaac-sim:developfrom
rwiltz:rwiltz/update-docs-physicx-handtarcking

Conversation

@rwiltz
Copy link
Copy Markdown
Contributor

@rwiltz rwiltz commented May 5, 2026

Description

Newton is not supported for real-time teleoperation in this release. Update the environments documentation to list the physx preset for all teleop environments so users know which physics backend to use.

Add physx preset to GR1, G1, Galbot, and Franka IK-Abs teleop entries in the visual environment table
Add missing teleop environments to the comprehensive list (PickPlace GR1T2, NutPour, ExhaustPipe, Locomanipulation G1, FixedBase G1, Stack-Cube-Franka-IK-Abs)
Add physx preset to existing Galbot stack entries in the comprehensive list
Remove duplicate Galbot/Agibot rows in the comprehensive list
Add a tip about hand tracking input mode to the CloudXR teleoperation guide
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

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 May 5, 2026
Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Choose a reason for hiding this comment

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

🤖 Isaac Lab Review Bot

Summary

This PR updates documentation to clarify that Newton physics backend is not supported for real-time teleoperation, explicitly adding physx preset annotations to teleop environment entries. It also adds a helpful tip about hand tracking input modes to the CloudXR guide and cleans up duplicate entries in the comprehensive environment list.

Architecture Impact

Self-contained. This is a documentation-only change with no code impact. The changes correctly inform users about physics backend requirements for teleoperation workflows.

Implementation Verdict

Minor fixes needed

Test Coverage

Not applicable — documentation-only PR. The checklist item "I have added tests that prove my fix is effective or that my feature works" is checked but no tests are needed for doc changes.

CI Status

No CI checks available yet. Documentation changes should pass standard CI once triggered.

Findings

🔵 Improvement: docs/source/overview/environments.rst:1108-1112 — Missing entry context
The newly added Isaac-Stack-Cube-Franka-IK-Abs-v0 entry is placed between unrelated environments (after the Dexsuite section header comment area). While technically valid RST, this appears to be inserted somewhat arbitrarily. Consider grouping with other Franka Stack entries for consistency, though the table is alphabetically organized in sections so this may be intentional.

🔵 Improvement: docs/source/overview/environments.rst:1161-1206 — Duplicate removal verification needed
The diff shows removal of duplicate Galbot/Agibot rows, but the resulting structure has Isaac-Stack-Cube-Galbot-Left-Arm-Gripper-RmpFlow-v0 appearing at line 1203 and Isaac-Stack-Cube-Galbot-Right-Arm-Suction-RmpFlow-v0 at lines 1196 and 1209. Looking at the full context, there appear to be entries for:

  • Isaac-Stack-Cube-Galbot-Left-Arm-Gripper-RmpFlow-v0 (line 1203)
  • Isaac-Stack-Cube-Galbot-Right-Arm-Suction-RmpFlow-v0 (line 1209)
  • Isaac-Stack-Cube-Galbot-Left-Arm-Gripper-Visuomotor-v0 (line 1213)

The full file is truncated at 30K chars, making it impossible to fully verify duplicate removal was complete. The author should confirm no duplicates remain.

🟡 Warning: docs/source/overview/environments.rst — Inconsistent preset documentation
Several similar manipulation environments have inconsistent preset documentation:

  • Isaac-Place-Mug-Agibot-Left-Arm-RmpFlow-v0 (line 1217) has no preset listed
  • Isaac-Place-Toy2Box-Agibot-Right-Arm-RmpFlow-v0 was removed but Agibot entries in the visual table (lines 193-196) still show no presets

If Newton is truly not supported for teleoperation environments, shouldn't the Agibot entries also have physx specified, or is there a reason they differ? The PR description mentions "Newton is not supported for real-time teleoperation in this release" but doesn't clarify which specific environments this applies to.

🔵 Improvement: docs/source/how-to/cloudxr_teleoperation.rst:123-128 — Cross-reference validation
The tip references :ref:isaac-teleop-control-schemes`` which should link to a table documenting input modes per task. This is good documentation practice. However, ensure this anchor exists and the linked table is up-to-date with the newly documented environments.

🔵 Improvement: docs/source/overview/environments.rst — Missing physx preset on OpenArm entries
The OpenArm manipulation entries (lines 197-208 in the visual table) show no presets. If these are also teleoperation-capable environments, should they also have physx specified for consistency with the stated goal of this PR?

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 5, 2026

Greptile Summary

This is a documentation-only PR that updates the environments reference and CloudXR teleoperation guide to clarify PhysX backend requirements for real-time teleoperation (Newton is unsupported for teleop in this release). Changes include adding the physx preset label to GR1, G1, Galbot, and Franka IK-Abs entries, adding six previously missing teleop environments to the comprehensive list, removing duplicate Galbot/Agibot rows, and inserting a tip in the CloudXR guide about enabling hand tracking for the Isaac-PickPlace-GR1T2-WaistEnabled-Abs-v0 task.

Confidence Score: 5/5

Documentation-only change with no code or logic modifications; safe to merge.

All changes are RST documentation updates: physx presets are added consistently to identified teleop environments, duplicate rows are cleanly removed, the new cross-reference in cloudxr_teleoperation.rst resolves to a valid label, and no code paths are affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/overview/environments.rst Adds physx presets to teleop environment rows in both the visual table and comprehensive list, adds six missing teleop environments, and removes duplicated Galbot/Agibot rows; changes are accurate and consistent.
docs/source/how-to/cloudxr_teleoperation.rst Inserts a tip block about hand-tracking requirements for the GR1T2 WaistEnabled task; the :ref: cross-reference to isaac-teleop-control-schemes is valid and the RST syntax is correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Teleop Environment Launch] --> B{PhysX backend?}
    B -- Yes --> C[Supported: GR1T2, G1, Galbot,\nFranka IK-Abs, NutPour,\nExhaustPipe, Locomanipulation G1,\nFixedBase G1]
    B -- No / Newton --> D[Not supported for\nreal-time teleoperation]
    C --> E{Input mode?}
    E -- Hand Tracking --> F[Isaac-PickPlace-GR1T2-WaistEnabled-Abs-v0\n+ others — enable XR hand tracking]
    E -- Motion Controllers --> G[Other teleop environments]
Loading

Reviews (1): Last reviewed commit: "Updating docs, explicitly call out physi..." | Re-trigger Greptile

@rwiltz rwiltz force-pushed the rwiltz/update-docs-physicx-handtarcking branch from e68bb56 to e243116 Compare May 5, 2026 15:19
Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Choose a reason for hiding this comment

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

🤖 Isaac Lab Review Bot

Summary

This is a follow-up review. Comparing the new commit against the previous review, the changes are identical — no new commits have been pushed since the last review.

Previous Findings Status

All previous findings remain applicable as no changes were made to address them:

  • The inconsistent preset documentation for Agibot entries is still present
  • The OpenArm entries still lack physx presets
  • The duplicate verification concern cannot be fully validated due to file truncation

Implementation Verdict

Ship it — this is a documentation-only PR that achieves its stated goal of clarifying PhysX support for teleoperation environments. The previous findings were all 🔵 improvements or clarification requests rather than blocking issues. The core documentation updates are correct and helpful for users.

@rwiltz rwiltz merged commit c0ae5ee into isaac-sim:develop May 5, 2026
33 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