Skip to content

Commit 493ee92

Browse files
StafaHooctipus
andauthored
[Docs] Overhaul Tutorial (#7435)
# Description Add one end-to-end SO-101 vial-placement tutorial based on the maintained `IsaacLabTutorial` project while preserving the focused Isaac Lab mini tutorials. The new page: - appears as a standalone **Tutorial** directly below Quickstart - points to the `IsaacLabTutorial` `main` branch and its maintained rollout - explains setup, package discovery, scene and MDP design, reset curriculum, validation, state-policy training, camera-policy distillation, evaluation, and extension - connects the downstream project structure to the Isaac Lab template generator The existing mini tutorials remain under the expandable **Tutorials** entry. The direct-workflow LEAPP tutorial and its annotation prerequisites are also retained. The deprecated Jetbot walkthrough remains removed. No source packages are changed, so no package changelog fragment is required. ## Type of change - Documentation update ## Screenshots The tutorial includes the SO-101 vial-placement rollout and a six-card navigation menu. The homepage navigation places **Tutorial** below Quickstart and keeps the mini tutorials under **Tutorials**. ## Validation - `uv run isaaclab -f` - `uv run --isolated --extra dev -- make -C docs current-docs` - Verified rendered navigation and the external `IsaacLabTutorial/main` rollout URL ## Checklist - [x] I have read and understood the contribution guidelines - [x] I have run the pre-commit checks with `uv run isaaclab -f` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] Tests are not required for this documentation-only change - [x] No changelog fragment is required because no source package changed - [x] My name already exists in `CONTRIBUTORS.md` ## Release backport - [x] <!-- backport-active-release --> Backport this pull request to the active release branch after it merges into `develop` --------- Co-authored-by: Octi Zhang <zhengyuz@nvidia.com>
1 parent d7d0976 commit 493ee92

14 files changed

Lines changed: 465 additions & 839 deletions

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ Table of Contents
9292
source/setup/installation/index
9393
source/setup/environments
9494
source/setup/quickstart
95+
source/setup/tutorial
9596
source/migration/migrating_to_isaaclab_3-0
9697

9798

@@ -112,7 +113,6 @@ Table of Contents
112113
:caption: Getting Started
113114
:titlesonly:
114115

115-
source/setup/walkthrough/index
116116
source/tutorials/index
117117
source/how-to/index
118118
source/overview/developer-guide/index
-181 KB
Binary file not shown.
-106 KB
Binary file not shown.

docs/source/_static/setup/walkthrough_sim_stage_scene.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/source/_static/setup/walkthrough_stage_context.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/source/_static/setup/walkthrough_training_vectors.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/source/overview/core-concepts/task_workflows.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,9 @@ For reinforcement learning, much of this has been done for you already! In most
6868

6969
.. seealso::
7070

71-
We provide a more detailed tutorial for setting up an environment using the manager-based workflow at
72-
:ref:`tutorial-create-manager-rl-env`.
71+
Start with :ref:`tutorial-create-manager-rl-env` for a focused manager-based environment example. Then follow
72+
the :ref:`SO-101 vial-placement tutorial <tutorial-so101-task>` for a complete manipulation task, including its
73+
scene, MDP terms, reset curriculum, and agent configuration.
7374

7475

7576
Direct Environments
@@ -117,10 +118,9 @@ operations in the environment.
117118

118119
.. seealso::
119120

120-
We provide a more detailed tutorial for setting up a RL environment using the direct workflow at
121+
We provide a detailed tutorial for setting up a direct RL environment at
121122
:ref:`tutorial-create-direct-rl-env`.
122123

123-
124124
.. _IsaacGymEnvs: https://github.com/isaac-sim/IsaacGymEnvs
125125
.. _OmniIsaacGymEnvs: https://github.com/isaac-sim/OmniIsaacGymEnvs
126126
.. _Pytorch JIT: https://pytorch.org/docs/stable/jit.html

0 commit comments

Comments
 (0)