Skip to content

Cherry-pick: Updates Rlinf docs#6172

Merged
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0-beta2from
mingxueg-nv:mingxue/fix_rlinf_docs-release-3.0.0-beta2
Jun 15, 2026
Merged

Cherry-pick: Updates Rlinf docs#6172
kellyguo11 merged 1 commit into
isaac-sim:release/3.0.0-beta2from
mingxueg-nv:mingxue/fix_rlinf_docs-release-3.0.0-beta2

Conversation

@mingxueg-nv

@mingxueg-nv mingxueg-nv commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Description

Add a note to the RLinf VLA post-training docs that Windows support is still being optimized and Linux is recommended for RLinf training and evaluation.

Type of change

  • Documentation update

Checklist

  • 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 updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels Jun 12, 2026
@greptile-apps

greptile-apps Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This documentation-only PR adds a platform-support note to the RLinf VLA post-training guide, advising users that Windows support is still being optimized and that Linux is the recommended platform for RLinf training and evaluation.

  • A single .. note:: block is inserted between the evaluation script description and the Checkpoints section, using valid RST syntax and matching the style of the adjacent note above it.

Confidence Score: 5/5

This is a docs-only change adding a single platform note with valid RST syntax — no risk to runtime behavior.

One .. note:: block is inserted with correct RST formatting, matching the style of the adjacent note. No code paths, APIs, or configuration are affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/source/experimental-features/rlinf_vla_posttraining.rst Adds a .. note:: directive warning that Windows support is still being optimized and Linux is recommended for RLinf training and evaluation. RST syntax is correct and the note is placed appropriately before the Checkpoints section.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[RLinf VLA Post-training Docs] --> B[Evaluation Script Description]
    B --> C[Note: config_path is optional]
    C --> D["Note: Windows support still being optimized\n(NEW - this PR)"]
    D --> E[Checkpoints Section]
Loading

Reviews (1): Last reviewed commit: "Note Windows support for RLinf is still ..." | Re-trigger Greptile

@kellyguo11 kellyguo11 merged commit 2a351df into isaac-sim:release/3.0.0-beta2 Jun 15, 2026
40 of 41 checks passed
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