docs: fix broken Isaac Lab documentation links - #827
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated two hyperlinks in the requirements documentation: the Isaac Lab Cloud Deployment link now targets the cloud-workstations section of the Docker Cloud documentation, and the Isaac Lab system requirements footnote now targets the Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
📝 Docs preview is not auto-deployed for fork PRs. A maintainer with write access to |
The Isaac Lab docs removed source/deployment/index.html; the cloud deployment content now lives in the "Cloud workstations" section of source/features/docker_cloud.html. The same reorg renamed the installation page's #general-requirements anchor to #system-requirements, which the Isaac Lab system requirements footnote pointed at. Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
fed017d to
9b595e9
Compare
Problem
The Teleoperation with Isaac Sim and Isaac Lab section of our
requirements page
links to
https://isaac-sim.github.io/IsaacLab/develop/source/deployment/index.html,which now 404s — the Isaac Lab docs reorganized that page away.
The same reorg also broke a second link in the same file: the Isaac Lab System
Requirements footnote points at
installation/index.html#general-requirements,and that anchor no longer exists on the page. The page still returns 200, so the
browser silently lands the reader at the top instead of the requirements section.
Fix
Two link updates in
docs/source/references/requirements.rst:source/deployment/index.htmlsource/features/docker_cloud.html#cloud-workstationssource/setup/installation/index.html#general-requirementssource/setup/installation/index.html#system-requirementsThe
#cloud-workstationsanchor lands the reader directly on the "Cloud Deployment"material (Isaac Automator, cloud workstation setup) rather than the top of the Docker
guide, which matches the intent of the surrounding sentence about hosting the
workstation in the cloud.
The
#system-requirementssection is the current home of the Ubuntu 22.04 / Python3.12 / driver 580.95.05 requirements that the footnote's table cites.
Verification
id="cloud-workstations"present.installation/index.html→ 200, butid="general-requirements"is absentand
id="system-requirements"is present.isaac-sim.github.io/IsaacLaband Isaac Sim docs link underdocs/and
README.mdwas checked for both HTTP status and anchor presence(
#isaaclab-installation-root,#teleoperation-imitation-learning) — all resolve.source/deploymentappeared in exactly one place.Closes #826
Summary by CodeRabbit