[Backport release/3.0.0] Consolidate and clean migration guide - #7459
Conversation
# 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)
Greptile SummaryConsolidates the Isaac Lab 3.0, Isaac Gym, simulation-comparison, and deformables migration material into one guide while retaining reusable include fragments.
Confidence Score: 5/5The 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
Reviews (1): Last reviewed commit: "[Docs] Consolidate and clean migration g..." | Re-trigger Greptile |
There was a problem hiding this comment.
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.
|
run-ci |
Description
Backports #7428 onto
release/3.0.0by 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
Release backport
developScreenshots
Not applicable.
Validation
uv run isaaclab -fuv run --no-project python tools/skills/cli.py check(21 skills validated)uv run --isolated --extra test -- make -C docs current-docsequivalent dependency-isolated Sphinx build (succeeded with no warnings;ovstagewas mocked because it is unavailable on macOS)Checklist
pre-commitchecks withuv run isaaclab -fsource/<pkg>/changelog.d/for every touched package (not applicable: no source package changed)CONTRIBUTORS.mdor my name already exists there