Skip to content

docs: add LeRobot and SO-101 getting-started guide#718

Merged
jiwenc-nv merged 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/lerobot-so101-docs
Jul 1, 2026
Merged

docs: add LeRobot and SO-101 getting-started guide#718
jiwenc-nv merged 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/lerobot-so101-docs

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

New multi-page section under docs/source/getting_started/lerobot/ for the end-to-end SO-101 pipeline on Isaac Teleop, LeRobot, and Isaac Lab:

  • index: overview, end-to-end workflow, and teleop/policy figures
  • devices: the XR controller and SO-101 Leader teleop devices
  • data_collection_real: record LeRobot datasets on hardware with either device, via the isaac_teleop_to_so101 example
  • data_collection_sim: record in Isaac Lab with the XR controller (the SO-101 Leader and LeRobot export are work-in-progress)
  • training_groot: GR00T N1.7 training (work-in-progress)

Also wires the landing page into the Getting Started toctree and adds a so101-leader-plugin ref label in device/joint_space.rst. Builds clean under sphinx-build -W.

Description

Fixes #(issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Testing

Checklist

  • I have read and understood the contribution guidelines
  • I have run the linter and formatter with SKIP=check-copyright-year pre-commit run --all-files
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix/feature works (or explained why not)
  • I have signed off all my commits (git commit -s) per the DCO

Summary by CodeRabbit

  • New Features

    • Added new getting-started documentation for SO-101, covering supported teleoperation devices, real-robot data collection, simulation data collection, and model training.
    • Introduced an overview page that links the full SO-101 workflow from teleoperation through dataset creation and policy training.
    • Added navigation links and reference anchors to make the new guides easier to find and cross-reference.
  • Documentation

    • Expanded setup, recording, and workflow instructions, including prerequisites, controls, and notes on current limitations and work-in-progress guidance.

@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview is not auto-deployed for fork PRs.

A maintainer with write access to NVIDIA/IsaacTeleop can deploy a preview by
commenting /preview-docs on this PR. Once deployed, the preview
will live at:

https://nvidia.github.io/IsaacTeleop/preview/pr-718/

@coderabbitai

coderabbitai Bot commented Jun 29, 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: 26f90ee3-e526-442a-b8e7-2d781741fdf6

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

A new getting_started/lerobot/ documentation section is added to the Isaac Teleop docs, covering the end-to-end SO-101 workflow with LeRobot. New pages describe supported teleop devices (XR controller and SO-101 leader arm), data collection in simulation (Isaac Lab tasks, XR controller workflow, HDF5 output), data collection on real hardware (XR and SO-101 leader workflows, recording controls, Hub push), and a stub GR00T N1.7 training page. The main index.rst toctree is updated to include the new section. A cross-reference anchor is added to the existing joint_space.rst page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: a new LeRobot and SO-101 getting-started docs guide.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@jiwenc-nv jiwenc-nv force-pushed the jiwenc/lerobot-so101-docs branch from a2370b4 to 82a2ba7 Compare June 29, 2026 07:21
@jiwenc-nv

Copy link
Copy Markdown
Collaborator Author

/preview-docs

@github-actions

Copy link
Copy Markdown
Contributor

✅ Preview deployed: https://NVIDIA.github.io/IsaacTeleop/preview/pr-718/

@jiwenc-nv jiwenc-nv requested review from nv-jakob and rwiltz July 1, 2026 04:22
New multi-page section under docs/source/getting_started/lerobot/ for the
end-to-end SO-101 pipeline on Isaac Teleop, LeRobot, and Isaac Lab:

- index: overview, end-to-end workflow, and teleop/policy figures
- devices: the XR controller and SO-101 Leader teleop devices
- data_collection_real: record LeRobot datasets on hardware with either
  device, via the isaac_teleop_to_so101 example
- data_collection_sim: record in Isaac Lab with the XR controller (the
  SO-101 Leader and LeRobot export are work-in-progress)
- training_groot: GR00T N1.7 training (work-in-progress)

Also wires the landing page into the Getting Started toctree and adds a
so101-leader-plugin ref label in device/joint_space.rst. Builds clean
under sphinx-build -W.

Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
@jiwenc-nv jiwenc-nv force-pushed the jiwenc/lerobot-so101-docs branch from 82a2ba7 to a7103b7 Compare July 1, 2026 19:47
@jiwenc-nv jiwenc-nv enabled auto-merge (rebase) July 1, 2026 19:49
@jiwenc-nv jiwenc-nv merged commit 8b75c1a into NVIDIA:main Jul 1, 2026
44 checks passed
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