Adds note that Pink actions and envs are Linux only - #7542
Conversation
Greptile SummaryAdds prominent documentation notices explaining that Pink inverse-kinematics actions and the Pink-dependent humanoid imitation workflows are supported only on Linux.
Confidence Score: 5/5The documentation-only PR appears safe to merge. The added notices accurately describe the platform constraints of the Pink action and all humanoid imitation workflows presented on the affected page. Important Files Changed
Reviews (1): Last reviewed commit: "add note that pink ik in linux only" | Re-trigger Greptile |
|
run-ci |
There was a problem hiding this comment.
Isaac Lab Review Bot
This documentation-only change adds Linux platform notices for Pink IK actions and the humanoid imitation-learning workflows. The reviewed edits do not alter runtime behavior or source packages.
- Design and architecture: The notices are placed at relevant discovery points: the MDP Actions API section and the existing important admonition on the humanoid imitation-learning page. No documentation structure or implementation architecture changes.
- API: No public symbols, configuration fields, defaults, exports, or compatibility surfaces change. The API-page admonition clearly identifies the affected Pink inverse-kinematics action and leaves the surrounding automodule directives intact.
- Implementation: The reStructuredText directive syntax and indentation are consistent with the surrounding documentation. One non-blocking wording tradeoff is that the humanoid page describes both its Mimic workflows and Pink IK tasks as Linux-only, which is broader than a Pink-only limitation, but it is scoped to the workflows on that page.
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.
|
Backported to |
# Description Pink IK is a Linux only package. Add note in docs to indicate this. Fixes # (issue) Windows users may not have been aware that Pink actions and envs are Linux only. ## 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) - Documentation update ## Release backport - [x] <!-- backport-active-release --> Backport this pull request to the active release branch after it merges into `develop` ## Checklist Docker and GPU tests run on demand. Push the commits you want tested, then comment `run-ci` on the pull request. - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] 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) - [x] 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 --> (cherry picked from commit 40ada0f)
Description
Pink IK is a Linux only package. Add note in docs to indicate this.
Fixes # (issue)
Windows users may not have been aware that Pink actions and envs are Linux only.
Type of change
Release backport
developChecklist
Docker and GPU tests run on demand. Push the commits you want tested, then
comment
run-cion the pull request.pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (do not editCHANGELOG.rstor bumpextension.toml— CI handles that)CONTRIBUTORS.mdor my name already exists there