Consolidate simulation performance guidance - #7365
Conversation
Greptile SummaryThe PR consolidates simulation-performance guidance into the troubleshooting reference while retaining the former how-to page as a compatibility pointer.
Confidence Score: 5/5The documentation-only PR appears safe to merge with its compatibility page and new cross-references intact. The former source page remains available as an orphaned compatibility pointer, the new Sphinx labels and document targets resolve in source, and the troubleshooting skill links to guidance that satisfies its added routing and evaluation requirements. Important Files Changed
Reviews (1): Last reviewed commit: "Consolidate simulation performance guida..." | Re-trigger Greptile |
There was a problem hiding this comment.
Isaac Lab Review Bot
The consolidation is coherent, but the compatibility stub removes the retired page’s generated section anchors, so existing deep links to those sections are no longer preserved.
- Design and architecture: Moving slow-simulation guidance into the troubleshooting reference and deferring broad tuning to maintained upstream guides is coherent. Retaining the old page as a stub preserves page-level links, but not links to its former sections.
- API: No code, CLI, or configuration APIs change. The new
simulation-performance-troubleshootinglabel and relative documentation references are consistent, but generated anchors such as#collision-geometriesand#cpu-governor-settings-on-linuxdisappear from the compatibility page and should be preserved or redirected. - Implementation: The troubleshooting content, Nsight cross-reference, skill workflow, routing table, and evaluation scenario are synchronized. The remaining fix is to add explicit compatibility targets for the removed headings on the stub or at their replacement destination.
Minor fixes needed. Posted 1 actionable finding inline.
Automated review; human maintainers own approval decisions.
| :orphan: | ||
|
|
||
| .. note:: | ||
| Simulation Performance |
There was a problem hiding this comment.
🔵 Suggestion · Api — Legacy section anchors lost on stub page
The stub replaces all prior headings, so generated anchors such as #collision-geometries, #cpu-governor-settings-on-linux, and #additional-performance-guides no longer exist. Deep links that include those fragments land on the pointer page without resolving, which partially undercuts the stated link-compatibility goal. Consider adding explicit .. _...: targets on this page (or in the new troubleshooting section) for the retired heading anchors.
|
run-ci |
|
Backported to |
## Description Consolidates the standalone simulation performance how-to into the troubleshooting reference, where users are more likely to look for slow simulation and training guidance. The previous page remains as a compatibility pointer so existing links continue to work. This also updates the Nsight profiling cross-reference, points broad tuning guidance to the maintained Isaac Sim performance guides, and synchronizes the setup-troubleshooting skill. ## Type of change - Documentation update ## Release backport - [x] <!-- backport-active-release --> Backport this pull request to the active release branch after it merges into `develop` ## Validation - uv run --isolated --extra test -- make -C docs current-docs - uv run --no-sync isaaclab -f - uv run --no-project python tools/skills/cli.py check - Baseline and skill-assisted slow-throughput routing evaluation ## Checklist - [x] I have read the contribution guidelines. - [x] I have run the pre-commit checks. - [x] I have updated the relevant documentation and troubleshooting skill. - [x] The documentation builds with warnings treated as errors. - [x] A changelog fragment is not required because no source package changed. Co-authored-by: Kelly Guo <kellyg@nvidia.com> (cherry picked from commit a77dbdc)
Description
Consolidates the standalone simulation performance how-to into the troubleshooting reference, where users are more likely to look for slow simulation and training guidance.
The previous page remains as a compatibility pointer so existing links continue to work. This also updates the Nsight profiling cross-reference, points broad tuning guidance to the maintained Isaac Sim performance guides, and synchronizes the setup-troubleshooting skill.
Type of change
Release backport
developValidation
Checklist