Skip to content

Adds note that Pink actions and envs are Linux only - #7542

Merged
kellyguo11 merged 1 commit into
isaac-sim:developfrom
peterd-NV:peterd/doc_fix_pink_envs_windows
Sep 3, 2026
Merged

Adds note that Pink actions and envs are Linux only#7542
kellyguo11 merged 1 commit into
isaac-sim:developfrom
peterd-NV:peterd/doc_fix_pink_envs_windows

Conversation

@peterd-NV

Copy link
Copy Markdown
Collaborator

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

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Release backport

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

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks 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

@peterd-NV
peterd-NV requested a review from a team September 3, 2026 17:56
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Sep 3, 2026
@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds prominent documentation notices explaining that Pink inverse-kinematics actions and the Pink-dependent humanoid imitation workflows are supported only on Linux.

  • Documents the platform limitation beside the Pink action API.
  • Warns users about Linux-only support before the humanoid imitation demonstrations.

Confidence Score: 5/5

The 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

Filename Overview
docs/source/api/lab/isaaclab.envs.mdp.rst Accurately documents the Linux-only platform support of PinkInverseKinematicsAction.
docs/source/overview/imitation-learning/humanoids_imitation.rst Adds an accurate Linux-only notice covering the Pink-dependent workflows presented on the page.

Reviews (1): Last reviewed commit: "add note that pink ik in linux only" | Re-trigger Greptile

@peterd-NV

Copy link
Copy Markdown
Collaborator 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 Sep 3, 2026

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

@kellyguo11
kellyguo11 merged commit 40ada0f into isaac-sim:develop Sep 3, 2026
53 checks passed
@isaaclab-bot

isaaclab-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Backported to release/3.0.0 as 7c63dee.

isaaclab-bot Bot pushed a commit that referenced this pull request Sep 3, 2026
# 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants