Skip to content

docs: fix broken Isaac Lab documentation links - #827

Open
jiwenc-nv wants to merge 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/fix-isaaclab-cloud-link
Open

docs: fix broken Isaac Lab documentation links#827
jiwenc-nv wants to merge 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc/fix-isaaclab-cloud-link

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

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:

Old New
source/deployment/index.html source/features/docker_cloud.html#cloud-workstations
source/setup/installation/index.html#general-requirements source/setup/installation/index.html#system-requirements

The #cloud-workstations anchor 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-requirements section is the current home of the Ubuntu 22.04 / Python
3.12 / driver 580.95.05 requirements that the footnote's table cites.

Verification

  • Old cloud URL → 404; new URL → 200 with id="cloud-workstations" present.
  • installation/index.html200, but id="general-requirements" is absent
    and id="system-requirements" is present.
  • Every other isaac-sim.github.io/IsaacLab and Isaac Sim docs link under docs/
    and README.md was checked for both HTTP status and anchor presence
    (#isaaclab-installation-root, #teleoperation-imitation-learning) — all resolve.
  • Repo-wide grep confirms source/deployment appeared in exactly one place.

Closes #826

Summary by CodeRabbit

  • Documentation
    • Updated CloudXR and Isaac Lab cloud-workstation documentation links.
    • Refined the Isaac Lab system requirements reference to point directly to the relevant section.

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 63a9561a-1f2b-4201-815a-39ad6e457c6d

📥 Commits

Reviewing files that changed from the base of the PR and between 7968ce1 and 9b595e9.

📒 Files selected for processing (1)
  • docs/source/references/requirements.rst

📝 Walkthrough

Walkthrough

Updated 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 #system-requirements anchor.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing broken Isaac Lab documentation links.
Linked Issues check ✅ Passed The PR updates the broken Isaac Lab cloud deployment link to the current Docker Cloud page, matching issue #826.
Out of Scope Changes check ✅ Passed The extra system-requirements anchor update is still related to the same broken documentation references, not unrelated scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview is not auto-deployed for fork PRs.

A maintainer with write access to NVIDIA/IsaacTeleop can deploy a preview by
commenting /preview-docs on this PR. Once deployed, the preview
will live at:

https://nvidia.github.io/IsaacTeleop/preview/pr-827/

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>
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc/fix-isaaclab-cloud-link branch from fed017d to 9b595e9 Compare July 27, 2026 22:02
@jiwenc-nv jiwenc-nv changed the title docs: fix broken Isaac Lab cloud deployment link docs: fix broken Isaac Lab documentation links Jul 27, 2026
@jiwenc-nv
jiwenc-nv marked this pull request as ready for review July 27, 2026 23:19
@jiwenc-nv
jiwenc-nv requested a review from rwiltz July 27, 2026 23:19
@jiwenc-nv
jiwenc-nv enabled auto-merge (rebase) July 27, 2026 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Links to Isaac Lab cloud deployment is broken

1 participant