Skip to content

[Backport 3.0.0] Clarify Linux-only support for RLinf - #7315

Merged
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0from
mingxueg-nv:mingxueg/clear_rlinf_documentation-release-3.0.0
Aug 24, 2026
Merged

[Backport 3.0.0] Clarify Linux-only support for RLinf#7315
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0from
mingxueg-nv:mingxueg/clear_rlinf_documentation-release-3.0.0

Conversation

@mingxueg-nv

Copy link
Copy Markdown
Contributor

Summary

Test plan

  • Run git diff --check.
  • Verify the rendered reStructuredText structure and command tabs.

@mingxueg-nv
mingxueg-nv requested a review from a team August 24, 2026 03:33
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 24, 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 backport consistently changes the RLinf guidance to Linux-only support, removes the conflicting Windows workaround and support note, and aligns command-tab labels with their existing shell commands.

  • Design and architecture: The platform-support boundary is placed prominently in Prerequisites before installation steps. Removing Windows-specific guidance keeps the page internally consistent; the broad distribution list will need to remain synchronized with upstream RLinf support.
  • API: No Python APIs, CLI flags, configuration keys, or exports change. The retained uv run isaaclab and ./isaaclab.sh commands match their updated tab labels, and no source-package changelog fragment is required.
  • Implementation: The changed reStructuredText preserves the existing directive nesting and indentation. The Windows patch.exe instructions, .bat labels, and outdated Windows optimization note are removed without disturbing the nearby aarch64 label or cross-reference.

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.

@greptile-apps

greptile-apps Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR clarifies that RLinf post-training is Linux-only and removes Windows-specific commands and labels.

  • Adds a prominent Linux platform-support notice.
  • Removes the Git for Windows patch workaround.
  • Renames command tabs to reference only isaaclab.sh.
  • Removes the previous provisional Windows-support note.

Confidence Score: 4/5

The distribution compatibility claim should be narrowed or substantiated before merging because it can direct users into unsupported RLinf installations.

The Linux-only clarification is appropriate, but naming Red Hat-family and Arch Linux as compatible conflicts with the documented Ubuntu 22.04+ requirement of the underlying full Isaac Sim workflow.

Files Needing Attention: docs/source/experimental-features/rlinf_vla_posttraining.rst

Important Files Changed

Filename Overview
docs/source/experimental-features/rlinf_vla_posttraining.rst The Windows cleanup is consistent, but the new notice advertises Red Hat-family and Arch Linux compatibility beyond the repository’s documented Ubuntu-only Linux support for full Isaac Sim workflows.

Reviews (1): Last reviewed commit: "Clarify Linux-only support for RLinf" | Re-trigger Greptile

Comment on lines +57 to +58
include Ubuntu and Debian, Red Hat-family distributions, and Arch Linux.

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.

P1 Unsupported distribution compatibility claim

When users follow this workflow on Red Hat-family or Arch Linux distributions, the notice advertises compatibility beyond the underlying full Isaac Sim workflow's documented Ubuntu 22.04+ support, causing unsupported installation or simulation failures; the documented aarch64 workaround also relies on the Debian-specific /lib/aarch64-linux-gnu/libgomp.so.1 path.

@kellyguo11
kellyguo11 merged commit ffd40fe into isaac-sim:release/3.0.0 Aug 24, 2026
46 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