[Docs] Overhaul Tutorial - #7435
Conversation
Greptile SummaryThe PR replaces the deprecated tutorial collection and Jetbot walkthrough with one end-to-end SO-101 vial-placement guide based on the maintained IsaacLabTutorial project.
Confidence Score: 4/5The broken rollout asset must be fixed before merging so the central tutorial media works on the published site. The tutorial references an MP4 under a static subdirectory that is neither configured for Sphinx copying nor handled by another build step, so the generated page cannot load the advertised rollout. Files Needing Attention: docs/source/tutorials/index.rst Important Files Changed
Reviews (1): Last reviewed commit: "Replace tutorials with SO-101 vial place..." | Re-trigger Greptile |
There was a problem hiding this comment.
Isaac Lab Review Bot
The tutorial consolidation is coherent, but three documentation integration gaps need correction: the direct-workflow LEAPP export prerequisite was removed, the event-randomization skill was not synchronized when its declared source pages were deleted, and the raw HTML video uses an incorrect output-relative path.
- Design and architecture: Replacing the disconnected tutorial collection with one downstream-project walkthrough is a reasonable restructuring. However, deleting both pages declared as the source of truth for the event-randomization skill without updating that repository-owned skill leaves its maintained guidance disconnected from the documentation architecture.
- API: The surviving cross-reference labels are appropriately retargeted, but the replacement LEAPP text says direct-workflow policies can be exported without explaining that their environments must first provide LEAPP input, output, and state annotations. That prerequisite must remain documented or link to a maintained guide.
- Implementation: The embedded rollout is emitted through raw HTML, so Sphinx will not rewrite its URL. From
source/tutorials/index.html,../_static/...resolves undersource/_staticrather than the build-root_static; the path should use../../_static/.... The repository-owned event-randomization skill also needs to be repointed or updated alongside deletion of its source-of-truth pages.
Minor fixes needed. Posted 3 actionable findings inline.
Automated review; human maintainers own approval decisions.
|
run-ci |
Four modify/delete conflicts, all from isaac-sim#7407 adding --extra flags to command lines in tutorial pages this branch removes. Kept the deletions: the surviving --extra fixes merged cleanly, and the new tutorial only invokes rsl_rl, which needs no extra.
AntoineRichard
left a comment
There was a problem hiding this comment.
Does the SO101 example covers all of the things that we removed? I'm all for something more integrated, but it's also nice to have simple blocks to explain specific API bits. Otherwise LGTM with Kelly's comments.
…101-tutorial # Conflicts: # docs/index.rst # docs/source/how-to/multi_asset_spawning.rst # docs/source/policy_deployment/05_leapp/exporting_direct_workflow_policies_with_leapp.rst # docs/source/policy_deployment/05_leapp/exporting_policies_with_leapp.rst # docs/source/tutorials/04_sensors/add_sensors_on_robot.rst # docs/source/tutorials/index.rst
|
run-ci |
Backports #7435 to `release/3.0.0`. The release branch advanced after this backport was created, causing a conflict in `docs/index.rst`. The original PR removes the walkthrough entry, while the updated release branch removes the old own-project entry. The resolution preserves both removals. Deterministic validation confirmed that the final diff against the updated release base has the same stable patch ID as the original merged change and changes no paths outside the original PR. | Field | Commit | |---|---| | Original merged change | `493ee92f8a9ccf62d1cd199ce90075fcd78c722a` | | Updated release base | `e79616ee6b8cc344bfdc2ea812a6dec25769748d` | | Resolved backport | `26e188e23eeaae24a1608407f62cdb43e1a1c8cc` | Validation: - `uv run isaaclab -f` - `uv run --isolated --extra test -- make -C docs current-docs` Co-authored-by: Mustafa H <34825877+StafaH@users.noreply.github.com> Co-authored-by: Mustafa Haiderbhai <mhaiderbhai@nvidia.com>
Description
Add one end-to-end SO-101 vial-placement tutorial based on the maintained
IsaacLabTutorialproject while preserving the focused Isaac Lab mini tutorials.The new page:
IsaacLabTutorialmainbranch and its maintained rolloutThe 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
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 -fuv run --isolated --extra dev -- make -C docs current-docsIsaacLabTutorial/mainrollout URLChecklist
uv run isaaclab -fCONTRIBUTORS.mdRelease backport
develop