Skip to content

Conversation

@kellyguo11
Copy link
Contributor

Description

Updates documentation for newton beta 2:

  • Installation instructions
  • Visualizers instructions
  • Multi-backends - folder restructuring and mechanism to switch between backends
  • Quaternion convention change - switching to XYZW
  • Warp dependency changes - data will be returned in Warp and users need to call wp.to_torch to convert to torch

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

kellyguo11 and others added 7 commits December 9, 2025 15:52
…ewton (#4231)

# Description

Adds some doc on Newton.

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

---------

Signed-off-by: James Tigue <[email protected]>
Signed-off-by: ooctipus <[email protected]>
Signed-off-by: Kelly Guo <[email protected]>
Signed-off-by: Brian McCann <[email protected]>
Signed-off-by: Kelly Guo <[email protected]>
Signed-off-by: Fan Dongxuan <[email protected]>
Signed-off-by: renezurbruegg <[email protected]>
Signed-off-by: Mayank Mittal <[email protected]>
Signed-off-by: Pascal Roth <[email protected]>
Co-authored-by: James Tigue <[email protected]>
Co-authored-by: Eva M. <[email protected]>
Co-authored-by: James Smith <[email protected]>
Co-authored-by: ooctipus <[email protected]>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: Kelly Guo <[email protected]>
Co-authored-by: Pascal Roth <[email protected]>
Co-authored-by: Toni-SM <[email protected]>
Co-authored-by: Yanzi Zhu <[email protected]>
Co-authored-by: Greg Attra <[email protected]>
Co-authored-by: rwiltz <[email protected]>
Co-authored-by: Brian McCann <[email protected]>
Co-authored-by: Krishna Lakhi <[email protected]>
Co-authored-by: Kyle Morgenstein <[email protected]>
Co-authored-by: Mayank Mittal <[email protected]>
Co-authored-by: Fan Dongxuan <[email protected]>
Co-authored-by: Ashwin Varghese Kuruttukulam <[email protected]>
Co-authored-by: renezurbruegg <[email protected]>
Co-authored-by: Pascal Roth <[email protected]>
Co-authored-by: Mayank Mittal <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: zrene <[email protected]>
Co-authored-by: yami007007-weihuaz <[email protected]>
# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link:
https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context.
List any dependencies that are required for this change.

Fixes # (issue)

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## 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)
- New feature (non-breaking change which adds functionality)
- Breaking change (existing functionality will not work without user
modification)
- Documentation update

## Screenshots

Please attach before and after screenshots of the change if applicable.

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit
mode and it should upload the image directly. You can then paste that
source into the above before/after sections.
-->

## Checklist

- [ ] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) 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

<!--
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
-->
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 17, 2025

Skipped: This PR changes more files than the configured file change limit: (167 files found, 100 file limit)

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request isaac-mimic Related to Isaac Mimic team isaac-lab Related to Isaac Lab team infrastructure labels Dec 17, 2025
@github-actions
Copy link

github-actions bot commented Dec 18, 2025

Test Results Summary

2 778 tests   2 300 ✅  2h 47m 23s ⏱️
  105 suites    477 💤
    1 files        0 ❌  1 🔥

For more details on these errors, see this check.

Results for commit b08fbd5.

♻️ This comment has been updated with latest results.

kellyguo11 and others added 5 commits December 18, 2025 10:02
# Description

<!--
Thank you for your interest in sending a pull request. Please make sure
to check the contribution guidelines.

Link:
https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html

💡 Please try to keep PRs small and focused. Large PRs are harder to
review and merge.
-->

Updates documentation for newton beta 2:

Visualizers instructions

<!-- As a practice, it is recommended to open an issue to have
discussions on the proposed pull request.
This makes it easier for the community to keep track of what is being
developed or added, and if a given feature
is demanded by more than one party. -->

## 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)
- New feature (non-breaking change which adds functionality)
- Breaking change (existing functionality will not work without user
modification)
- Documentation update

## Screenshots

Please attach before and after screenshots of the change if applicable.

<!--
Example:

| Before | After |
| ------ | ----- |
| _gif/png before_ | _gif/png after_ |

To upload images to a PR -- simply drag and drop an image while in edit
mode and it should upload the image directly. You can then paste that
source into the above before/after sections.
-->

## Checklist

- [ ] I have read and understood the [contribution
guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html)
- [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) 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

<!--
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: matthewtrepte <[email protected]>
Signed-off-by: Kelly Guo <[email protected]>
Co-authored-by: Kelly Guo <[email protected]>
Co-authored-by: Kelly Guo <[email protected]>
Copy link
Contributor

@matthewtrepte matthewtrepte left a comment

Choose a reason for hiding this comment

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

made a few tweaks, looks good

@kellyguo11 kellyguo11 merged commit 9d17b52 into main Dec 20, 2025
9 of 12 checks passed
@kellyguo11 kellyguo11 deleted the feature/newton-beta2-docs branch December 20, 2025 02:06
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 enhancement New feature or request infrastructure isaac-lab Related to Isaac Lab team isaac-mimic Related to Isaac Mimic team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants