Skip to content

Updates Newton docs on main for 3.0 beta changes#4934

Merged
kellyguo11 merged 1 commit into
isaac-sim:mainfrom
kellyguo11:update-newton-docs-main
Mar 10, 2026
Merged

Updates Newton docs on main for 3.0 beta changes#4934
kellyguo11 merged 1 commit into
isaac-sim:mainfrom
kellyguo11:update-newton-docs-main

Conversation

@kellyguo11

Copy link
Copy Markdown
Contributor

Description

Updates Newton docs on main for 3.0 beta changes

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 Mar 10, 2026
@greptile-apps

greptile-apps Bot commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR updates the Newton Physics Integration documentation to reflect Isaac Lab 3.0 Beta changes, migrating all references from the feature/newton experimental branch to the develop branch. It refreshes installation instructions (uv package manager, Python 3.12, Isaac Sim 6.0, PyTorch 2.10.0), updates the supported task list, renames OVVisualizerCfgKitVisualizerCfg, moves visualizer imports to the new isaaclab_visualizers package, and adds new RerunVisualizerCfg fields (grpc_port, bind_address).

  • Updated all Newton external doc URLs to include /latest/ for stable link resolution
  • Replaced conda-based install workflow with the uv package manager and Python 3.12
  • Removed the outdated "What's Next?" section now that 3.0 Beta is live
  • Updated the supported task list (added Isaac-Dexsuite-Kuka-Allegro-Lift-v0, removed Isaac-Velocity-Flat-Cassie-v0)
  • CLI visualizer syntax changed from space-separated to comma-delimited (no spaces) — callers using the old syntax will need to update
  • Minor: the installation.rst subsection was renamed from Pip Installation to Installation, creating a duplicate of the page title

Confidence Score: 5/5

  • Documentation-only PR with no code changes — safe to merge.
  • All changes are confined to RST documentation files. The updates are internally consistent (branch name, package versions, import paths all align with the 3.0 Beta story). Only minor style nits were found — no broken logic or structural errors that would prevent the docs from rendering correctly.
  • No files require special attention beyond the minor style suggestions on installation.rst and visualization.rst.

Important Files Changed

Filename Overview
docs/source/experimental-features/newton-physics-integration/index.rst Updated Newton doc URLs to include /latest/ path segment, changed branch references from feature/newton to develop, and removed outdated PhysX support messaging. Clean and accurate.
docs/source/experimental-features/newton-physics-integration/installation.rst Updated install instructions to use uv, Python 3.12, Isaac Sim 6.0, and torch 2.10.0/torchvision 0.25.0. Minor issue: subsection heading renamed from "Pip Installation" to "Installation", creating an ambiguous duplicate of the page title.
docs/source/experimental-features/newton-physics-integration/isaaclab_newton-beta-2.rst Renamed from "Isaac Lab - Newton Beta 2" to "Isaac Lab 3.0 Beta" and removed the now-obsolete "What's Next?" section. Changes are accurate and clean.
docs/source/experimental-features/newton-physics-integration/training-environments.rst Updated supported task list: removed Isaac-Cartpole-RGB/Depth-Camera-Direct-v0 and Isaac-Velocity-Flat-Cassie-v0, added Isaac-Cartpole-Camera-Presets-Direct-v0 and Isaac-Dexsuite-Kuka-Allegro-Lift-v0. Straightforward update.
docs/source/experimental-features/newton-physics-integration/visualization.rst Updated import paths from isaaclab.visualizers to isaaclab_visualizers.*, renamed OVVisualizerCfg to KitVisualizerCfg, updated CLI syntax to comma-delimited, added grpc_port/bind_address to RerunVisualizerCfg. Minor: bind_address comment is unclear.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Clone Isaac Lab repo] --> B[git checkout develop]
    B --> C[Install uv package manager]
    C --> D["uv venv --python 3.12 --seed env_isaaclab"]
    D --> E[source env_isaaclab/bin/activate]
    E --> F{Use Isaac Sim?}
    F -- Yes --> G["uv pip install isaacsim[all,extscache]==6.0.0"]
    F -- No --> H
    G --> H["uv pip install torch==2.10.0 torchvision==0.25.0 --index-url .../cu128"]
    H --> I["./isaaclab.sh -i  (installs Newton 1.0)"]
    I --> J[Verify: zero_agent.py --task Isaac-Cartpole-Direct-v0]
    J --> K{Choose visualizer}
    K -- Kit/Omniverse --> L["from isaaclab_visualizers.kit import KitVisualizerCfg"]
    K -- Newton --> M["from isaaclab_visualizers.newton import NewtonVisualizerCfg"]
    K -- Rerun --> N["from isaaclab_visualizers.rerun import RerunVisualizerCfg"]
    L & M & N --> O["SimulationCfg(visualizer_cfgs=[...])"]
Loading

Last reviewed commit: 7739ff0

Comment on lines +19 to +20
Installation
------------

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.

Duplicate "Installation" heading

The top-level page title (line 1) and the new subsection header (line 19) both use the text Installation, which creates a confusing structure where a section is nested under a parent with the same name. The previous heading Pip Installation was unambiguous. Consider renaming the subsection to something more descriptive, e.g. Installing Dependencies or Setting Up the Environment, to distinguish it from the page title.

Suggested change
Installation
------------
Setting Up the Environment
--------------------------

app_id="isaaclab-simulation", # Application identifier for viewer
grpc_port=9876, # gRPC endpoint for logging SDK connection
web_port=9090, # Port for local web viewer (launched in browser)
bind_address="0.0.0.0", # Endpoint host formatting/reuse checks

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.

Misleading bind_address comment

The inline comment # Endpoint host formatting/reuse checks doesn't describe what bind_address does — it reads like a developer implementation note rather than user-facing documentation. A bind_address parameter controls which network interface the server listens on. Consider a clearer description:

Suggested change
bind_address="0.0.0.0", # Endpoint host formatting/reuse checks
bind_address="0.0.0.0", # Network interface to bind the gRPC/web server to

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@kellyguo11 kellyguo11 merged commit f4aa17f into isaac-sim:main Mar 10, 2026
5 of 8 checks passed
zuxinrui pushed a commit to zuxinrui/IsaacLab that referenced this pull request Mar 11, 2026
# Description

Updates Newton docs on main for 3.0 beta changes


## 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
-->
nitesh-subedi pushed a commit to nitesh-subedi/IsaacLab that referenced this pull request Mar 24, 2026
# Description

Updates Newton docs on main for 3.0 beta changes


## 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
-->
kellyguo11 added a commit that referenced this pull request May 28, 2026
# Description

Merge changes from main branch:

- #4875 - Adds Isaac-Stack-Cube-Franka-IK-Rel-v0 task variants
- #4909 - Updates minor RSL-RL configclass docstring
- #4934 - Updates Newton docs on main for 3.0 beta changes
- #5182 - Fix flatdict version pin to allow 4.1.0+
- #5195 - Add NCCL troubleshooting notes
- #5406 - Updates doc building job on main to match develop
- #5311 - Update skrl integration for version 2.0.0
- #5482 - Adds nightly-changelog.yml on main
- #5527 - Use isaaclab-bot GitHub App token for nightly changelog push
- #5537 - Address deprecation warnings in nightly changelog workflow
- #5746 - Fix .dockerignore for _isaac_sim symlink
- #5745 - Parameterize nightly compile over configurable branches
- #5546 - Fix swapped preserve_order docstrings
- #5817 - Update skrl agent configurations in the Isaac Lab template
kellyguo11 added a commit to kellyguo11/IsaacLab-public that referenced this pull request May 28, 2026
# Description

Merge changes from main branch:

- isaac-sim#4875 - Adds Isaac-Stack-Cube-Franka-IK-Rel-v0 task variants
- isaac-sim#4909 - Updates minor RSL-RL configclass docstring
- isaac-sim#4934 - Updates Newton docs on main for 3.0 beta changes
- isaac-sim#5182 - Fix flatdict version pin to allow 4.1.0+
- isaac-sim#5195 - Add NCCL troubleshooting notes
- isaac-sim#5406 - Updates doc building job on main to match develop
- isaac-sim#5311 - Update skrl integration for version 2.0.0
- isaac-sim#5482 - Adds nightly-changelog.yml on main
- isaac-sim#5527 - Use isaaclab-bot GitHub App token for nightly changelog push
- isaac-sim#5537 - Address deprecation warnings in nightly changelog workflow
- isaac-sim#5746 - Fix .dockerignore for _isaac_sim symlink
- isaac-sim#5745 - Parameterize nightly compile over configurable branches
- isaac-sim#5546 - Fix swapped preserve_order docstrings
- isaac-sim#5817 - Update skrl agent configurations in the Isaac Lab template
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