Skip to content

Document AgiBot teleop envs in Isaac Teleop docs#6110

Open
rwiltz wants to merge 1 commit into
isaac-sim:release/3.0.0-beta2from
rwiltz:rwiltz/docs-agibot-teleop-envs-beta2
Open

Document AgiBot teleop envs in Isaac Teleop docs#6110
rwiltz wants to merge 1 commit into
isaac-sim:release/3.0.0-beta2from
rwiltz:rwiltz/docs-agibot-teleop-envs-beta2

Conversation

@rwiltz

@rwiltz rwiltz commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Description

Backport of # to release/3.0.0-beta2.
Cherry-picks the documentation fix that adds the two AgiBot place tasks to the
Keyboard and SpaceMouse Environments table in
docs/source/features/isaac_teleop.rst:

  • Isaac-Place-Mug-Agibot-Left-Arm-RmpFlow-v0
  • Isaac-Place-Toy2Box-Agibot-Right-Arm-RmpFlow-v0
    The original QA report was filed against the 3.0.0-beta2 docs, so the fix is
    backported here as well. Both task IDs are registered on this release (at
    manager_based/manipulation/place/config/agibot/ — the pre-contrib/ path) and
    expose teleop_devices (keyboard, SpaceMouse), so the table entries are accurate
    for beta2. Applied cleanly via git cherry-pick -x (provenance recorded).

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

Add the two keyboard/SpaceMouse AgiBot place environments
(Isaac-Place-Mug-Agibot-Left-Arm-RmpFlow-v0 and
Isaac-Place-Toy2Box-Agibot-Right-Arm-RmpFlow-v0) to the
Keyboard and SpaceMouse Environments reference table.

Both configs expose teleop_devices (keyboard, SpaceMouse) and use
RMPFlow arm control with a binary gripper, matching the documented
Galbot RMPFlow tasks, but were missing from the table.

(cherry picked from commit 46d0961)
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 10, 2026
@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR backports a documentation fix from develop to release/3.0.0-beta2, adding the two AgiBot place tasks to the Keyboard and SpaceMouse Environments table in docs/source/features/isaac_teleop.rst. Both task IDs (Isaac-Place-Mug-Agibot-Left-Arm-RmpFlow-v0 and Isaac-Place-Toy2Box-Agibot-Right-Arm-RmpFlow-v0) are registered exactly as documented in manager_based/manipulation/place/config/agibot/__init__.py, and the arm-side / controller descriptions are accurate.

  • Adds two new rows to the RST list-table for the Agibot left-arm mug-place and right-arm toy2box-place environments, including correct device support (Keyboard, SpaceMouse) and control description (RMPFlow, gripper K/SpaceMouse left button).
  • No code changes; documentation only.

Confidence Score: 5/5

Documentation-only change that adds two table rows; all task IDs and control descriptions match the registered environments.

Both added task IDs were verified against agibot/init.py — they match exactly. Arm-side labels (left/right), controller (RMPFlow), and input bindings (K / SpaceMouse left) are consistent with the existing Galbot entries that use the same robot family and control scheme. The RST table syntax is valid and the new rows slot in cleanly between the Galbot and UR10 blocks.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/features/isaac_teleop.rst Adds two AgiBot place-task rows to the Keyboard and SpaceMouse Environments table; task IDs, arm side, and controller descriptions match the registered gym environments.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens Isaac Teleop docs] --> B[Keyboard & SpaceMouse Environments table]
    B --> C[Isaac-Place-Mug-Agibot-Left-Arm-RmpFlow-v0\nLeft-arm · RMPFlow · Gripper K/SpaceMouse left]
    B --> D[Isaac-Place-Toy2Box-Agibot-Right-Arm-RmpFlow-v0\nRight-arm · RMPFlow · Gripper K/SpaceMouse left]
    C --> E[Registered in\nagibot/__init__.py]
    D --> E
Loading

Reviews (1): Last reviewed commit: "Document AgiBot teleop envs in Isaac Tel..." | Re-trigger Greptile

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 Documentation Review — PR #6110

Summary: This PR adds two AgiBot teleop environment entries to the "Keyboard and SpaceMouse Environments" table in docs/source/features/isaac_teleop.rst.

✅ Looks Good

  • RST formatting is consistent with the surrounding table entries (indentation, column alignment, list-table syntax all correct).
  • Placement is logical — the AgiBot entries sit between the Galbot and UR10 blocks.
  • Content follows the established pattern: env ID, supported devices, and a brief description of arm control + gripper activation.
  • pre-commit and other CI checks are passing.

💡 Minor Observations (non-blocking)

  1. Alphabetical/grouped ordering: The existing table loosely groups entries by robot (Franka → Galbot → UR10 → Franka again). The new AgiBot entries are placed between Galbot and UR10, which is reasonable but could also be grouped with other "Place" tasks if the table grows. Fine as-is for now.

  2. Missing Note block for RMPFlow? The Galbot RMPFlow entry above (Isaac-Stack-Cube-Galbot-Right-Arm-Suction-RmpFlow-v0) includes a warning about avoiding collisions that cause controller overtuning. If the same caveat applies to the AgiBot RMPFlow environments, consider adding a similar note in a follow-up.

  3. PR body references #<develop PR> with a link to #6109 — just confirming the backport chain is tracked. The cherry-pick provenance is noted in the body, which is good practice.

Verdict

Clean docs-only change, correctly formatted. No issues found. 👍

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.

1 participant