Skip to content

Fix broken external links flagged by lychee#5576

Open
ooctipus wants to merge 2 commits into
isaac-sim:developfrom
ooctipus:octi/fix-broken-doc-links
Open

Fix broken external links flagged by lychee#5576
ooctipus wants to merge 2 commits into
isaac-sim:developfrom
ooctipus:octi/fix-broken-doc-links

Conversation

@ooctipus
Copy link
Copy Markdown
Collaborator

Summary

  • docs/source/setup/ecosystem.rst: https://robosuite.ai/ now returns 404. Updated the RoboSuite reference link to the project's GitHub repo (https://github.com/ARISE-Initiative/robosuite).
  • docs/source/how-to/cloudxr_teleoperation.rst: https://github.com/NVIDIA/IsaacTeleop/blob/main/src/plugins/manus/README.md is gone (404). The IsaacTeleop repo root still resolves, so the Manus plugin reference now points there until the upstream doc is republished.

These were the two failures from the Documentation Links CI job; everything else lychee reported was a 301/302 redirect already in the accept list.

Test plan

  • pre-commit run --files docs/source/how-to/cloudxr_teleoperation.rst docs/source/setup/ecosystem.rst — passes.
  • Re-run Documentation Links on the PR — expect zero [ERROR] entries.

robosuite.ai now returns 404; point to the project's GitHub repo instead.
The Manus plugin README at IsaacTeleop/blob/main/src/plugins/manus/README.md
has been moved or removed; redirect readers to the Isaac Teleop repo root.
@github-actions github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation labels May 11, 2026
Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Looks Good

Clean fix for the two broken links flagged by lychee.

Changes verified:

  • docs/source/setup/ecosystem.rst: RoboSuite link updated from robosuite.ai (404) → GitHub repo. ✓
  • docs/source/how-to/cloudxr_teleoperation.rst: Dead Manus plugin README link → Isaac Teleop repo root. ✓

Both replacement URLs resolve correctly. The Isaac Teleop repo root is a reasonable fallback until the Manus docs are republished upstream.

No concerns — straightforward link maintenance.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 11, 2026

Greptile Summary

This PR fixes two broken external links caught by the lychee Documentation Links CI job — replacing a deleted Manus plugin README path in cloudxr_teleoperation.rst with the IsaacTeleop repo root, and swapping robosuite.ai in ecosystem.rst for the project's GitHub repo.

  • cloudxr_teleoperation.rst: The specific Manus plugin README (/blob/main/src/plugins/manus/README.md) no longer exists in the IsaacTeleop repo; pointing to the repo root is a reasonable temporary fallback.
  • ecosystem.rst: robosuite.ai is replaced with https://github.com/ARISE-Initiative/robosuite, but external checks suggest the original domain may still be live — worth re-verifying before merging.

Confidence Score: 4/5

Documentation-only change with no runtime impact; the IsaacTeleop fix is solid, but the robosuite.ai link replacement warrants a quick re-check before merging.

The Manus plugin link update is straightforward — the upstream path is gone and the repo root is a valid temporary target. The robosuite.ai swap is less clear-cut: external lookups show the domain still serving content, and the GitHub repo itself lists robosuite.ai as the canonical project homepage, so the replacement may be unnecessary or even a regression in link quality. No code logic is touched.

docs/source/setup/ecosystem.rst — the robosuite.ai domain should be re-verified to confirm it is actually returning 404 before the link is permanently changed to the GitHub repo.

Important Files Changed

Filename Overview
docs/source/how-to/cloudxr_teleoperation.rst Replaced a 404 Manus plugin README link with the IsaacTeleop repo root; the change is accurate and the repo root is a valid fallback.
docs/source/setup/ecosystem.rst Replaced robosuite.ai with the GitHub repo, but robosuite.ai appears to still be live; the GitHub repo itself links back to robosuite.ai as the canonical homepage.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[lychee CI scan] -->|ERROR: 404| B[robosuite.ai]
    A -->|ERROR: 404| C[IsaacTeleop Manus README path]

    B --> D["ecosystem.rst\nRoboSuite link"]
    C --> E["cloudxr_teleoperation.rst\nManus plugin link"]

    D -->|Updated to| F[github.com/ARISE-Initiative/robosuite]
    E -->|Updated to| G[github.com/NVIDIA/IsaacTeleop root]

    F -->|Note| H{robosuite.ai\nstill reachable?}
    H -->|Yes - re-verify| I[Consider reverting to canonical homepage]
    H -->|No - confirmed dead| J[GitHub repo is correct fallback]
Loading

Reviews (1): Last reviewed commit: "Fix broken external links flagged by lyc..." | Re-trigger Greptile

.. _ManiSkill: https://github.com/haosulab/ManiSkill
.. _ThreeDWorld: https://www.threedworld.org/
.. _RoboSuite: https://robosuite.ai/
.. _RoboSuite: https://github.com/ARISE-Initiative/robosuite
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.

P2 Possibly premature link replacementhttps://robosuite.ai/ appears to still be reachable. Web lookups return the full robosuite homepage content, and the GitHub repo itself (ARISE-Initiative/robosuite) lists robosuite.ai as the project's canonical website. Pointing readers to the GitHub repo instead of the project's own homepage is a downgrade in documentation quality; if lychee flagged it, it may have been a transient failure or a redirect that lychee doesn't follow. Consider re-checking the URL before merging — if it truly resolves now, the original link is preferable.

Signed-off-by: Kelly Guo <kellyg@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants