Updates Newton docs on main for 3.0 beta changes#4934
Conversation
Greptile SummaryThis PR updates the Newton Physics Integration documentation to reflect Isaac Lab 3.0 Beta changes, migrating all references from the
Confidence Score: 5/5
Important Files Changed
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=[...])"]
Last reviewed commit: 7739ff0 |
| Installation | ||
| ------------ |
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
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:
| 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!
# 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 -->
# 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 -->
# 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
# 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
Description
Updates Newton docs on main for 3.0 beta changes
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there