Skip to content

[Docs] Streamline getting-started pages - #7183

Merged
StafaH merged 5 commits into
isaac-sim:developfrom
StafaH:docs/streamline-quickstart
Aug 24, 2026
Merged

[Docs] Streamline getting-started pages#7183
StafaH merged 5 commits into
isaac-sim:developfrom
StafaH:docs/streamline-quickstart

Conversation

@StafaH

@StafaH StafaH commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

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

@StafaH
StafaH requested a review from a team August 19, 2026 19:58
@github-actions github-actions Bot added documentation Improvements or additions to documentation infrastructure labels Aug 19, 2026
@greptile-apps

greptile-apps Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR consolidates environment discovery into the interactive browser and moves scripted state-machine instructions into a focused how-to guide.

  • Removes the legacy environment catalog and simple-agent overview pages while updating documentation and skill references.
  • Adds two quickstart GIFs illustrating agent behavior and representative tasks.
  • Changes environment-browser generation to preserve preview images from existing generated rows, with focused tests.

Confidence Score: 4/5

The 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

Filename Overview
docs/source/overview/environments.rst Deletes the legacy catalog, but its published URL remains linked from README.md without a redirect.
tools/environ_docs.py Moves preview-image collection to generated browser rows while retaining correct compatibility and image field positions.
tools/update_environments_rst.py Simplifies regeneration to update only the environment-browser JavaScript.
tools/test/test_environ_docs.py Adds focused coverage for preserving preview assignments from generated browser rows.
docs/source/how-to/run_state_machines.rst Adds runnable state-machine examples whose documented script paths and arguments match the current entry points.
docs/source/setup/quickstart.rst Adds compact task and agent demonstrations and redirects environment discovery to the browser.

Comments Outside Diff (1)

  1. docs/source/overview/environments.rst

    P1 Deleted environment documentation URL

    When a user follows the environment documentation link retained in README.md or an existing bookmark, deleting this page removes /source/overview/environments.html, causing a 404 instead of opening the replacement environment browser. Update the remaining link and preserve the published URL with a redirect.

Reviews (1): Last reviewed commit: "Streamline getting-started documentation" | Re-trigger Greptile

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 --check and --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.py and tools/test/test_environ_docs.py.

Minor fixes needed. Posted 1 actionable finding inline.

Automated review; human maintainers own approval decisions.

Comment thread tools/environ_docs.py
}

# Marker comments that delimit the auto-generated section in environments.rst.
# Legacy markers retained for the table-formatting helpers. The public

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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.

@StafaH
StafaH merged commit 3fcc9c6 into isaac-sim:develop Aug 24, 2026
46 of 47 checks passed
ooctipus pushed a commit to ooctipus/IsaacLab that referenced this pull request Aug 24, 2026
# 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)
ooctipus added a commit that referenced this pull request Aug 24, 2026
…#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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants