[pull] develop from isaac-sim:develop - #41
Merged
Merged
Conversation
# Description <!-- Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines. Link: https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html 💡 Please try to keep PRs small and focused. Large PRs are harder to review and merge. --> Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. Fixes # (issue) <!-- As a practice, it is recommended to open an issue to have discussions on the proposed pull request. This makes it easier for the community to keep track of what is being developed or added, and if a given feature is demanded by more than one party. --> ## Type of change <!-- As you go through the list, delete the ones that are not applicable. --> - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (existing functionality will not work without user modification) - Documentation update ## Release backport - [x] <!-- backport-active-release --> Backport this pull request to the active release branch after it merges into `develop` ## Screenshots Please attach before and after screenshots of the change if applicable. <!-- Example: | Before | After | | ------ | ----- | | _gif/png before_ | _gif/png after_ | To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections. --> ## Checklist Docker and GPU tests run on demand. Push the commits you want tested, then comment `run-ci` on the pull request. - [ ] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [ ] 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 - [ ] I have added a changelog fragment under `source/<pkg>/changelog.d/` for every touched package (do **not** edit `CHANGELOG.rst` or bump `extension.toml` — CI handles that) - [ ] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task --> ## Summary Pin published-wheel commands to `3.0.0rc1` on NVIDIA PyPI and separate them from the Git installation workflow. Preserve the existing importer and Isaac Sim overrides, using the matching release tag, and retain standard code blocks and existing optional-extra guidance. This is a documentation-only change with no new dependencies. ## Validation - Formatting and pre-commit checks passed. - Structural checks confirmed that the original code-block formatting, Windows activation path, and optional-extra guidance are preserved. - Local HTML rendering was not rerun for the final revision; the local environment lacks Sphinx. - Runtime installation and simulation tests were not run.
…es (#7819) ## Description Consolidate overlapping robot/articulation guidance into one worked guide and split Docker, image, cloud and cluster documentation into workflow pages. Move the 19 tutorial guides into `how-to/`, retaining their Python examples and compatibility URLs. Update importer/backend guidance and repair the examples used by these pages: resolve ROS package meshes, correct OSC target quaternions, and place the warehouse height scanner below the roof. Retain MPC/OCS2, the historical Warp benchmarks, configuration/default-resolution tables, and original screenshots. No replacement media or Newton material-import fix is included. ## Consolidation and preservation - Replace the robot overview and adding-a-robot pages with the expanded articulation guide, including their configuration rules, complete runnable example and original result figure. - Replace the combined Docker page and include fragments with four workflow pages. Retain the logging example and cluster/cloud procedures. Document every CLI command/option with ordinary tables; no custom CLI generator or parser refactor remains. - Preserve 23 old page URLs and legacy section anchors; route old Docker cluster/cloud sections to their new pages. Update terminal diagnostics to the specific updated guide paths, preserving the branchless `/IsaacLab/source/...` URL format. - Correct Docker volume-deletion guidance to match `stop` (`down --volumes`), restore copy-before-stop and permission prerequisites, and repair source/document links. ## Type of change Documentation update and example bug fixes. No source-package changes requiring package changelog fragments. ## Validation - Warning-free full documentation build and final guide refreshes; formatting/pre-commit passed. - Three redirect tests and 15 Docker profile tests passed. New split-section regression failed before the fix and passed afterward; all six CLI help entry points checked. - Rendered audit: 32 destination pages, 244 original anchors and 882 local links/images; no missing anchors, original illustrations or local targets. Browser checked 28 redirect/query/fragment cases. Original Warp/articulation table text preserved; all 15 Compose volumes documented. - Earlier runtime checks covered converter outputs, PhysX/Kit examples and Newton warehouse inference with the accepted walking recording. These were not rerun after the latest develop sync. - Windows, fresh Docker image builds, cloud/cluster deployment and every backend combination remain untested. ## Screenshots Existing screenshots retained; replacement images deferred. ## Checklist - [x] Read contribution guidelines; contributor already listed - [x] Formatting/pre-commit and documentation validation passed - [x] Added focused redirect regression coverage - [x] No source-package changes requiring package changelog fragments - [ ] Release backport ## Release backport - [x] <!-- backport-active-release --> Backport this pull request to the active release branch after it merges into `develop`
github-actions
Bot
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )