Skip to content

Conversation

@kellyguo11
Copy link
Contributor

Description

Documentation update for release notes for the 2.3 release and some final updates on recommended driver versions.

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 the documentation Improvements or additions to documentation label Oct 28, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Greptile Summary

This PR updates release documentation for Isaac Lab version 2.3.0, including comprehensive release notes and updated system requirements. The changes update Isaac Sim dependency from 4.2.0 to 5.1.0, Python from 3.10 to 3.11, and significantly updates NVIDIA driver recommendations across platforms (Linux: 535→580.65.06, new Spark: 580.95.05, Windows: 580.88). The release notes document new features like DexSuite integration, surface gripper updates, SkillGen/Mimic improvements, teleoperation enhancements, and numerous bug fixes. These changes follow the established pattern in the changelog files and maintain consistency with the IsaacLab documentation structure for versioned releases.

PR Description Notes:

  • The PR body mentions "some final updates on recommended driver versions" which aligns with the Linux/Spark/Windows driver version updates in the installation documentation

Important Files Changed

Filename Score Overview
docs/source/setup/installation/index.rst 3/5 Updates Isaac Sim (4.2.0→5.1.0), Python (3.10→3.11), and driver version requirements; contains typo "envrionements"
docs/source/refs/release_notes.rst 3/5 Adds v2.3.0 release notes with features, improvements, and fixes; has markdown link syntax error and typo "Locomamipulation"

Confidence score: 3/5

  • This PR has several minor issues that should be corrected before merging, including formatting errors and typos in user-facing documentation
  • Score reflects documentation-only changes with no code logic modified, but deducted points for: (1) typo "envrionements" on line 94 of installation/index.rst, (2) markdown link syntax [cuRobo license](...) on line 31 of release_notes.rst that won't render properly in RST format, (3) typo "Locomamipulation" on line 33 of release_notes.rst, and (4) inconsistent date reference on line 55 mentioning "October 14, 2025" when context indicates current date is October 28, 2025
  • Pay close attention to docs/source/refs/release_notes.rst (line 31 markdown link, line 33 typo, line 55 date) and docs/source/setup/installation/index.rst (line 94 typo)

2 files reviewed, 4 comments

Edit Code Review Agent Settings | Greptile

* **Mimic - SkillGen**: SkillGen support has been added for the Mimic Imitation Learning pipeline,
introducing cuRobo integration, integrating GPU motion planning with skill-segmented data generation.
Note that cuRobo has proprietary licensing terms, please review the
[cuRobo license](https://github.com/isaac-sim/IsaacLab/blob/main/docs/licenses/dependencies/cuRobo-license.txt)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: markdown link syntax doesn't render correctly in RST. use :attr:`cuRobo license <https://github.com/isaac-sim/IsaacLab/blob/main/docs/licenses/dependencies/cuRobo-license.txt>`_ or similar RST syntax

Note that cuRobo has proprietary licensing terms, please review the
[cuRobo license](https://github.com/isaac-sim/IsaacLab/blob/main/docs/licenses/dependencies/cuRobo-license.txt)
carefully before use.
* **Mimic - Locomamipulation**: Added a new G1 humanoid environment combining RL-based locomotion with IK-based
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: typo: 'Locomamipulation' should be 'Locomanipulation'

gripper penetration issues, especially for cases with sub-optimally tuned joints.
* Surface grippers has been optimized for better performance. Although support continues to be CPU-only,
performance has improved by several orders of magnitude compared to previous releases.
* Windows 10 support ended on October 14, 2025. Microsoft will no longer provide free security, feature, or technical
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

logic: October 14, 2025 is a future date (current date is 2025-10-28). this should likely be 2024 or the sentence needs adjustment

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Signed-off-by: Kelly Guo <[email protected]>
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Greptile Summary

This review covers only the changes made since the last review, not the entire PR. The most recent changes include driver version updates across all platforms and multi-node training clarification. The driver recommendations have been updated to version 580.x series across Linux (580.65.06), Spark (580.95.05), and Windows (580.88), representing a significant version jump from the previous 535.x series on Linux. Additionally, the language around multi-node training on Spark has been refined to indicate it may require additional network configurations rather than being completely unsupported. These updates align the documentation with Isaac Sim 5.1.0 requirements and provide more accurate technical guidance for users deploying Isaac Lab in production environments.

Important Files Changed

Filename Score Overview
docs/source/setup/installation/index.rst 4/5 Updates NVIDIA driver recommendations to 580.x series across all platforms and clarifies multi-node training requirements on Spark
docs/source/refs/release_notes.rst 4/5 Adds comprehensive release notes for Isaac Lab v2.3.0 with all previously identified issues now addressed

Confidence score: 4/5

  • This PR is safe to merge with only minor concerns remaining around verification of the specific driver versions.
  • Score reflects that the documentation changes are well-structured and previous issues have been addressed, but driver version updates represent significant changes (535.x to 580.x on Linux) that should be verified as compatible with the release.
  • Pay close attention to docs/source/setup/installation/index.rst lines 65-68 to ensure the driver version numbers (especially 580.65.06for Linux, 580.95.05 for Spark, and 580.88 for Windows) are correct and officially supported by NVIDIA for Isaac Sim 5.1.0.

Additional Comments (1)

  1. docs/source/setup/installation/index.rst, line 86-88 (link)

    syntax: RST link syntax appears malformed - angle bracket should be underscore. Should be JAX <https://docs.jax.dev/en/latest/notebooks/thinking_in_jax.html>_`

2 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Greptile Summary

This review covers only the changes made since the last review. The PR continues to polish the release notes documentation for the 2.3 release by addressing previously identified issues. Changes include: correcting RST link syntax for the cuRobo license reference, fixing the "Locomanipulation" typo in the G1 humanoid environment description, and correcting a date error where October 14, 2025was referenced as a past event. These are final documentation quality improvements ensuring the release notes are accurate and properly formatted for publication.

Important Files Changed

Filename Score Overview
docs/source/refs/release_notes.rst 5/5 Fixed RST link syntax, corrected typo in "Locomanipulation", and fixed date error from 2025 to appropriate year

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it contains only documentation corrections.
  • Score reflects simple, non-functional documentation fixes that address syntax errors, typos, and factual inaccuracies with no impact on code behavior.
  • No files require special attention as all changes are straightforward documentation corrections.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@kellyguo11 kellyguo11 merged commit 34ea176 into isaac-sim:release/2.3.0 Oct 28, 2025
7 of 12 checks passed
kellyguo11 added a commit to kellyguo11/IsaacLab-public that referenced this pull request Oct 28, 2025
# Description

Documentation update for release notes for the 2.3 release and some
final updates on recommended driver versions.

## Type of change

- Documentation update

## Checklist

- [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 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

<!--
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
-->

---------

Signed-off-by: Kelly Guo <[email protected]>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
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.

1 participant