Fixes environment task names in release docs#6126
Conversation
There was a problem hiding this comment.
📝 Documentation Review — Task Name Fixes
Summary: This PR correctly updates environment task names across 17 documentation files to include version suffixes (e.g., Isaac-Cartpole → Isaac-Cartpole-v0), aligning the docs with the registered task names in the 3.0.0-beta2 release.
✅ Changes look good overall
The following rename patterns are applied consistently:
Isaac-Cartpole→Isaac-Cartpole-v0Isaac-Cartpole-Direct→Isaac-Cartpole-Direct-v0Isaac-Cartpole-Camera-Direct→Isaac-Cartpole-Camera-Presets-Direct-v0
Additionally, camera-related examples now use --rl_library rl_games instead of rsl_rl, which appears intentional.
🔍 Minor observation
In docs/source/setup/quickstart.rst, the camera task example uses Isaac-Cartpole-RGB-Camera-Direct-v0:
./isaaclab.sh train --rl_library rl_games --task=Isaac-Cartpole-RGB-Camera-Direct-v0 physics=newton_mjwarp renderer=newton_renderer presets=rgbWhile in other files (e.g., quickstart_details.rst, rl_existing_scripts.rst, hydra.rst), the equivalent camera task is named Isaac-Cartpole-Camera-Presets-Direct-v0. If these are distinct registered tasks (one with RGB baked in, one generic with presets), this is fine. Otherwise, it may be worth unifying for reader clarity.
CI Status
pre-commit✅ passedCheck for Broken Links✅ passedBuild Latest Docs⏳ pending- Other checks skipped (docs-only change)
LGTM — straightforward docs fix. 🎉
Greptile SummaryThis PR fixes stale environment task names across 17 release documentation files, adding the required
Confidence Score: 4/5The documentation corrections are accurate for 16 of 17 files; quickstart.rst uses a task name that does not match the preset-selection example it is paired with. The quickstart.rst camera example pairs Isaac-Cartpole-RGB-Camera-Direct-v0 with presets=rgb, but every parallel doc uses Isaac-Cartpole-Camera-Presets-Direct-v0 for the same command. A user following quickstart.rst would reference a fixed-config task that has no preset plumbing, making the presets=rgb override silently ineffective. All other changes are straightforward and correct. docs/source/setup/quickstart.rst — the camera task name in the presets example needs to match what all other docs use. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Docs: task name reference] --> B{Task type}
B -->|Manager-based| C[Isaac-Cartpole-v0\nmanager_based/classic/cartpole]
B -->|Direct workflow| D[Isaac-Cartpole-Direct-v0\ndirect/cartpole]
B -->|Camera + Presets| E[Isaac-Cartpole-Camera-Presets-Direct-v0\ndirect/cartpole]
B -->|Fixed RGB Camera| F[Isaac-Cartpole-RGB-Camera-Direct-v0\ndirect/cartpole]
E --> G[quickstart_details.rst\nhydra.rst\ncamera.rst\nvisualization.rst\nrl_existing_scripts.rst]
F --> H[quickstart.rst ⚠️\nused with presets=rgb]
style H fill:#ffcccc
style E fill:#ccffcc
style F fill:#ffe0b2
Reviews (1): Last reviewed commit: "Fixes environment task names in release ..." | Re-trigger Greptile |
| ./isaaclab.sh train --rl_library rl_games \ | ||
| --task=Isaac-Cartpole-RGB-Camera-Direct-v0 \ | ||
| physics=newton_mjwarp renderer=newton_renderer presets=rgb |
There was a problem hiding this comment.
Inconsistent camera task name with
presets=rgb override
quickstart.rst uses Isaac-Cartpole-RGB-Camera-Direct-v0 while every other updated doc (quickstart_details.rst, hydra.rst, camera.rst, visualization.rst, rl_existing_scripts.rst) uses Isaac-Cartpole-Camera-Presets-Direct-v0 for the same camera + presets example command. Isaac-Cartpole-RGB-Camera-Direct-v0 is a fixed-config RGB task without preset support, so passing presets=rgb as a Hydra override is likely a no-op or undefined behavior here; Isaac-Cartpole-Camera-Presets-Direct-v0 is the task explicitly built for preset selection via Hydra.
| ./isaaclab.sh train --rl_library rl_games \ | |
| --task=Isaac-Cartpole-RGB-Camera-Direct-v0 \ | |
| physics=newton_mjwarp renderer=newton_renderer presets=rgb | |
| ./isaaclab.sh train --rl_library rl_games \ | |
| --task=Isaac-Cartpole-Camera-Presets-Direct-v0 \ | |
| physics=newton_mjwarp renderer=newton_renderer presets=rgb |
Description
Fixes task names that were incorrectly updated on the release branch from changes in develop. Adds back -v0 for cartpole names.
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there