Skip to content

[Backport release/3.0.0] Consolidate and clean migration guide - #7459

Merged
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0from
kellyguo11:codex/backport-7428-release-3.0.0
Aug 31, 2026
Merged

[Backport release/3.0.0] Consolidate and clean migration guide#7459
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0from
kellyguo11:codex/backport-7428-release-3.0.0

Conversation

@kellyguo11

Copy link
Copy Markdown
Contributor

Description

Backports #7428 onto release/3.0.0 by cherry-picking the merged squash commit (9055a1e5e9a77141ee2188aa7e636bdf6193acab).

This consolidates the Isaac Lab migration guides and updates the related repository skills. The backport patch ID matches the original commit.

Type of change

  • Documentation update

Release backport

  • Backport this pull request to the active release branch after it merges into develop

Screenshots

Not applicable.

Validation

  • uv run isaaclab -f
  • uv run --no-project python tools/skills/cli.py check (21 skills validated)
  • uv run --isolated --extra test -- make -C docs current-docs equivalent dependency-isolated Sphinx build (succeeded with no warnings; ovstage was mocked because it is unavailable on macOS)

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with uv run isaaclab -f
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (not applicable: documentation and skill routing only)
  • I have added a changelog fragment under source/<pkg>/changelog.d/ for every touched package (not applicable: no source package changed)
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

# Description

Consolidates the migration documentation into one user-facing guide
instead of separate nested pages.

- Adds a starting-point chooser and in-page table of contents, with the
Isaac Gym migration link first.
- Includes the Isaac Gym, simulation comparison, and deformables content
directly in the main migration guide.
- Keeps the former subpage sources as include-only fragments so Sphinx
does not build standalone pages.
- Adds a concise recommended workflow for Isaac Gym migrations.
- Updates the Isaac Gym migration skill to point to the consolidated
guide.

## Type of change

- Documentation update

## Release backport

- [x] Backport this pull request to the active release branch after it
merges into `develop`

## Screenshots

Not applicable.

## Validation

- `uv run --isolated --extra test -- make -C docs current-docs`
- `uv run --no-project python tools/skills/cli.py check`
- Formatting, RST, codespell, and Git LFS pre-commit checks

## Checklist

- [x] I have read and understood the contribution guidelines
- [x] I have run the formatting and pre-commit checks
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] My name already exists in `CONTRIBUTORS.md`
- [x] Tests are not applicable to this documentation-only change
- [x] Changelog fragments are not applicable because no `source/<pkg>/`
package changed

(cherry picked from commit 9055a1e)
@kellyguo11
kellyguo11 requested a review from a team August 31, 2026 21:40
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 31, 2026
@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Consolidates the Isaac Lab 3.0, Isaac Gym, simulation-comparison, and deformables migration material into one guide while retaining reusable include fragments.

  • Excludes migration fragments from standalone Sphinx source discovery and includes them in the consolidated page.
  • Reorganizes and expands the 2.x-to-3.0 migration workflow, commands, API guidance, and examples.
  • Updates migration skills to route users to the consolidated source of truth.

Confidence Score: 5/5

The documentation-only backport appears safe to merge, with no concrete broken links, invalid routing, or implementation mismatches identified.

The include fragments are excluded from standalone discovery and incorporated into the consolidated guide, their explicit labels remain available, repository searches found no stale references to the removed page names, and checked commands and presets align with the release implementation.

Important Files Changed

Filename Overview
docs/conf.py Excludes the new migration include directory from standalone Sphinx page generation, matching the existing include-fragment pattern.
docs/source/migration/migrating_to_isaaclab_3-0.rst Consolidates and substantially reorganizes migration guidance, then includes the three relocated migration fragments.
docs/source/migration/include/from_isaacgymenvs.rst Converts the Isaac Gym migration page into an embeddable section while preserving its explicit cross-reference label.
docs/source/migration/include/comparing_simulation_isaacgym.rst Converts simulation-comparison documentation into an include fragment with paths appropriate to the consolidated page.
docs/source/migration/include/deformables.rst Converts deformables migration guidance into an included section while retaining its stable label.
skills/user/migrate-2x-to-3x/SKILL.md Updates the skill workflow to use the consolidated migration guide as its canonical source.
skills/user/migrate-from-isaac-gym/SKILL.md Updates skill routing and references to the Isaac Gym section of the consolidated guide.

Reviews (1): Last reviewed commit: "[Docs] Consolidate and clean migration g..." | 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

This documentation backport consolidates the Isaac Gym and deformables migration material into include-only fragments, excludes those fragments from standalone Sphinx discovery, and updates repository skills to route users to the consolidated 3.0 guide. No candidate findings were supplied or supported.

  • Design and architecture: The include-fragment structure follows the repository’s existing documentation convention. Heading demotion and removal of the fragment-local toctree are consistent with embedding the material in a consolidated guide rather than publishing duplicate standalone pages.
  • API: No runtime API changes are introduced. Existing reStructuredText labels for the Isaac Gym, simulation-comparison, and deformables sections remain present, preserving label-based cross-references. Skill references now target the consolidated guide and its Isaac Gym section.
  • Implementation: The Sphinx exclusion covers the new migration include directory while retaining include processing, and the skill changes remain concise routing updates. The provided patch omitted the body of the substantially changed consolidated guide, so its include wiring, generated section anchor, and any handling of former standalone page URLs could not be independently rechecked from this review input; these remain non-blocking integration risks given the reported warning-free documentation build.

No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.

Automated review; human maintainers own approval decisions.

@kellyguo11

Copy link
Copy Markdown
Contributor Author

run-ci

@isaaclab-bot isaaclab-bot Bot added ci:run-docker Trigger the on-demand Docker and GPU CI workflow and removed ci:run-docker Trigger the on-demand Docker and GPU CI workflow labels Aug 31, 2026
@kellyguo11
kellyguo11 merged commit 150dc3b into isaac-sim:release/3.0.0 Aug 31, 2026
47 checks passed
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants