[Docs] Streamline getting-started pages - #7183
Conversation
Greptile SummaryThis PR consolidates environment discovery into the interactive browser and moves scripted state-machine instructions into a focused how-to guide.
Confidence Score: 4/5The documentation move needs its remaining README link updated or the old published URL redirected before merging. Deleting the environment catalog removes the target of a current repository link, so users following that documented entry point will receive a 404. Files Needing Attention: docs/source/overview/environments.rst and README.md Important Files Changed
|
There was a problem hiding this comment.
Isaac Lab Review Bot
The documentation consolidation consistently redirects environment references to the generated browser and preserves preview assignments during regeneration. One cleanup remains: the deleted RST catalog’s generation helpers, markers, and tests are still retained as dead infrastructure.
- Design and architecture: Using the environment-browser rows as the source for both selectors and preview assignments removes the catalog dependency. However, retaining the obsolete comprehensive-list pipeline leaves two apparent documentation architectures and creates avoidable maintenance ambiguity.
- API: The updater CLI intentionally removes the obsolete RST output while preserving
--checkand--browser_output. The replacement preview-image helper is consistently used by the updater and its focused test. - Implementation: The browser parser and renderer support the preview-preservation round trip. Remove the now-unused comprehensive RST markers, rendering and patching helpers, and their catalog-specific tests from
tools/environ_docs.pyandtools/test/test_environ_docs.py.
Minor fixes needed. Posted 1 actionable finding inline.
Automated review; human maintainers own approval decisions.
| } | ||
|
|
||
| # Marker comments that delimit the auto-generated section in environments.rst. | ||
| # Legacy markers retained for the table-formatting helpers. The public |
There was a problem hiding this comment.
🔵 Suggestion · Implementation — Unused RST table generators kept after page deletion
docs/source/overview/environments.rst is deleted and update_environments_rst.py no longer imports render_comprehensive_list_table, patch_environments_rst, or patch_curated_environment_tables, yet these helpers and the COMPREHENSIVE_LIST_* markers stay exported and are still exercised by tools/test/test_environ_docs.py. They now target a file that cannot exist, leaving maintenance burden and a misleading picture of the docs pipeline. Consider removing them and their tests with the page.
…quickstart # Conflicts: # docs/source/overview/environments.rst
# Description Streamlines the getting-started documentation and points environment discovery to the interactive browser. - Refreshes the quickstart GIFs with OVRTX rendering. - Uses the Franka drawer task for the zero, random, and trained-policy comparison. - Adds a page-scoped generator at `tools/docs/media/generate_quickstart.sh` so the media can be reproduced. - Preserves environment-browser preview assignments without the removed catalog page. ## Validation - `tools/docs/media/generate_quickstart.sh` - `uv run --frozen isaaclab -f` - `uv run --frozen --isolated --extra test -- make -C docs current-docs` - Existing focused environment-browser checks (cherry picked from commit 3fcc9c6)
…#7303 (#7313) # Description Backports six merged PRs to `release/3.0.0` as separate provenance-preserving cherry-picks: | Source PR | Source commit | Backport commit | Scope | | --- | --- | --- | --- | | #7272 | `0081477fea2` | `c9fc1997476` | Fix scene-wide gravity distributions for PhysX and OvPhysX. | | #7121 | `9f65e3d4fd2` | `cce8acd84e1` | Fix backend-factory fallback before simulator initialization. | | #7183 | `3fcc9c6b824` | `99d58d3d3c4` | Streamline the getting-started documentation. | | #7306 | `6aad90be0ae` | `9a786cc028a` | Optimize Newton test runtime. | | #7305 | `1c9ba908cf1` | `a2dc8ce948e` | Disable Warp autodiff in the test suite. | | #7303 | `393fc37d2b0` | `249a5cb97d8` | Remove post-Hydra preset resolution. | #7272 forwards the validated `uniform`, `log_uniform`, or `gaussian` distribution through both scene-wide backend paths. Newton behavior is unchanged. #7121 makes factory resolution fall back to Newton when no `SimulationContext` exists while retaining the visualizer contract of reporting no active backend before context creation. #7183 is documentation-only. #7306 and #7305 change test infrastructure only; they do not change runtime behavior. #7303 makes `resolve_task_config` and `parse_env_cfg` the task-composition boundary. Runtime consumers now require concrete physics, renderer, and camera configurations and no longer attempt late preset fallback after Hydra composition. The branch was synchronized with the current `release/3.0.0` tip containing #7301 before #7303 was applied. All six source cherry-picks applied without conflicts. A file-by-file existence, mode, and blob audit confirmed that every #7303 path matches its merged source commit exactly. ## Validation ### #7272 - Regression verification against the unpatched `release/3.0.0` tip — both PhysX and OvPhysX cases failed as expected. - `uv run --extra test --frozen python -m pytest -q source/isaaclab/test/envs/test_gravity_randomization.py source/isaaclab/test/envs/test_mdp_event_selectors.py` — 7 passed. - `uv run --extra test --extra ovphysx --frozen python -m pytest -q source/isaaclab_ov/test/physics/test_ovphysx_gravity.py` — 1 passed. ### #7121 - Regression verification before the #7121 cherry-pick reproduced the original `NoneType.physics_manager` failure. - `uv run --extra test --frozen python -m pytest -q source/isaaclab/test/utils/test_backend_utils.py source/isaaclab/test/visualizers/test_visualizer.py` — 18 passed. ### #7183 - `uv run --frozen --extra test python -m pytest --noconftest -q tools/test/test_environ_docs.py` — 26 passed. ### #7306 - All 9 affected paths match the merged source PR exactly. - The full simulator-backed Newton suite is left to backport CI because this local worktree does not include the full Isaac Sim runtime. ### #7305 - Loaded the root `conftest.py` successfully with Warp unavailable. - Loaded it with Warp installed and confirmed `wp.config.enable_backward is False`. ### #7303 - Hydra and Shadow Hand camera suites — 129 passed. - Benchmark capture and RL entrypoint suites — 31 passed. - Experimental frontend and custom-coupling suites — 74 passed, 1 skipped. - Ruff and Ruff-format passed for every changed Python path. - Source/backport audit — 54 paths checked, 0 mismatches. - The Isaac Sim-backed integration case is left to CI because this local worktree is kitless. ### Repository gates - `git diff --check upstream/release/3.0.0...HEAD` — passed. --------- Signed-off-by: Sylvester Kaczmarek <16242628+sylvesterkaczmarek@users.noreply.github.com> Co-authored-by: Antoine RICHARD <antoiner@nvidia.com> Co-authored-by: Sylvester Kaczmarek <16242628+sylvesterkaczmarek@users.noreply.github.com> Co-authored-by: Mustafa H <34825877+StafaH@users.noreply.github.com>
Description
Streamlines the getting-started documentation and points environment discovery to the interactive browser.
tools/docs/media/generate_quickstart.shso the media can be reproduced.Validation
tools/docs/media/generate_quickstart.shuv run --frozen isaaclab -fuv run --frozen --isolated --extra test -- make -C docs current-docs