Remove stale Newton sim-to-real docs for unregistered G1 tasks#5747
Remove stale Newton sim-to-real docs for unregistered G1 tasks#5747AntoineRichard wants to merge 1 commit into
Conversation
The Newton sim-to-real walkthrough referenced three task IDs that no longer exist in source: * Isaac-Velocity-Flat-G1-v1 * Velocity-G1-Distillation-v1 * Velocity-G1-Student-Finetune-v1 The latter two were deleted from the g1 task registry in isaac-sim#668; the v1 flat task ID was never registered. Following the doc and pasting any of its commands now fails with `Environment version `v1` for environment `Isaac-Velocity-Flat-G1` doesn't exist`. Remove the dead doc and every reference to it: * delete docs/.../newton-physics-integration/sim-to-real.rst * drop `sim-to-real` from the Newton index toctree and the prose pointer that linked into it * drop the `Isaac-Velocity-Flat-G1-v1 (Sim-to-Real tested)` bullet from training-environments.rst * drop the `:ref:\`sim2real\`` resource link from the gear-assembly policy walkthrough
There was a problem hiding this comment.
📋 Isaac Lab Review Bot — PR #5747
Summary: Clean documentation removal that addresses broken user-facing documentation.
✅ Review Assessment
Changes look good. This PR correctly removes stale documentation that referenced unregistered task IDs:
-
sim-to-real.rst(deleted) — The walkthrough referenced three task IDs that don't exist: -
index.rst— Prose pointer to:ref:\sim2real`` and toctree entry properly removed -
training-environments.rst— Removed theIsaac-Velocity-Flat-G1-v1 (Sim-to-Real tested)bullet from the task list -
gear_assembly_policy.rst— Removed the dangling:ref:\sim2real`` link from Further Resources
🔍 Verification Notes
- The companion
sim-to-sim.rstdoc is correctly preserved (it references only-v0tasks which still exist) - No orphaned references remain after this cleanup
- PR description confirms grep verification was performed for dead refs
- No code changes, just doc cleanup — no test impact expected
📊 CI Status
pre-commit: ✅ Passlabeler: ✅ Pass- Doc build and other checks: Pending (expected for fresh PR)
No blocking issues identified.
Automated review by Isaac Lab Review Bot
Greptile SummaryThis PR removes a stale Newton sim-to-real walkthrough (
Confidence Score: 5/5Safe to merge — pure documentation deletion with no source code changes. All four changes are targeted removal of a broken walkthrough and its cross-references. A grep across the full repo confirms zero remaining references to the deleted sim2real label or the three unregistered task IDs. The companion sim-to-sim.rst doc is untouched and only references task IDs that still exist. No code, configs, or tests are affected. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Newton Physics Integration Docs] --> B[index.rst]
B --> C[limitations-and-known-bugs]
B --> D[solver-transitioning]
B --> E[sim-to-sim.rst kept]
B -. removed .-> F[sim-to-real.rst deleted]
G[training-environments.rst] -. removed bullet .-> H[Isaac-Velocity-Flat-G1-v1 Sim-to-Real tested]
G --> I[Isaac-Velocity-Flat-G1-v0 kept]
J[gear_assembly_policy.rst Further Resources] -. removed link .-> K[ref sim2real]
J --> L[External links kept]
style F fill:#ffcccc,stroke:#cc0000
style H fill:#ffcccc,stroke:#cc0000
style K fill:#ffcccc,stroke:#cc0000
style E fill:#ccffcc,stroke:#006600
style I fill:#ccffcc,stroke:#006600
Reviews (1): Last reviewed commit: "Remove stale Newton sim-to-real docs for..." | Re-trigger Greptile |
Description
The Newton sim-to-real walkthrough at
docs/source/experimental-features/newton-physics-integration/sim-to-real.rstinstructed users to run three task IDs:Isaac-Velocity-Flat-G1-v1Velocity-G1-Distillation-v1Velocity-G1-Student-Finetune-v1None of these are registered in source. The two distillation tasks were removed from
source/isaaclab_tasks/.../velocity/config/g1/__init__.pyin #668; theIsaac-Velocity-Flat-G1-v1ID never existed ingym.registerat all (verified withgit log --all -S"Isaac-Velocity-Flat-G1-v1").Following the doc therefore reproducibly fails with:
This PR deletes the dead walkthrough and every reference to it:
docs/source/experimental-features/newton-physics-integration/sim-to-real.rstsim-to-realentry from the Newton index toctree and the prose pointer (Please see :ref:\here ``…) that linked into itIsaac-Velocity-Flat-G1-v1 (Sim-to-Real tested)bullet fromtraining-environments.rst:ref:\sim2real`` "Further Resources" link from the gear-assembly policy walkthrough (the only other doc that targeted the deleted ref label)A grep across the source tree confirms no remaining references to any of the dead task IDs or the
sim2realref label.The companion
sim-to-sim.rstdoc is left in place — it only referencesIsaac-Velocity-Flat-G1-v0(and-H1-v0,-Go2-v0,-Anymal-D-v0), all of which still exist.Fixes # (no tracking issue — user-reported "environment
v1doesn't exist" error while following the published doc)Type of change
Screenshots
N/A — pure doc deletion / reference cleanup.
Checklist
pre-commitchecks with./isaaclab.sh --formatgrepfor dead refs returning empty)config/extension.tomlfile (N/A — nosource/<package>/touched)CONTRIBUTORS.mdor my name already exists there