Fix MEDIUM-severity issues: stale Jazzy links, dead pages - #35
Merged
Merged
Conversation
- Update 11 stale ROS distro links (Humble/Foxy) to their Jazzy
equivalents. Every target URL was verified to resolve on the current
Jazzy docs, including the Jazzy reorganisations:
* Understanding-ROS2-Parameters -> .../Understanding-ROS2-Parameters/
Understanding-ROS2-Parameters.html
* Launch-Main.html -> Creating-Launch-Files.html (no longer exists on Jazzy)
* About-Quality-of-Service-Settings -> Concepts/Intermediate/
* About-ROS-Interfaces -> Concepts/Basic/About-Interfaces
* Concepts.html#quick-overview -> Concepts/Basic.html (anchor removed)
* docs.ros2.org/<distro>/api/... (old layout, now 404) ->
docs.ros.org/en/jazzy/p/rclpy|tf2_ros/...
* rclpy timer.hpp: humble -> jazzy branch
- Add gazebo/other_content to the Gazebo toctree so the previously
unreachable 'Gazebo and ROS2 structure' page is now reachable.
- Remove three dead RST files (referenced by nothing):
* docker/troubleshooting.rst (content already inlined in docker/index.rst)
* the_pycharm_dependencies_warning.rst (orphaned + dangling :ref:)
* the_section_is_optional.rst (orphaned)
Co-authored-by: openhands <openhands@all-hands.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the HIGH-severity fixes. This PR addresses the remaining MEDIUM items found in the tutorial audit.
1. Update 11 stale distro links to Jazzy
The tutorial was updated to ROS 2 Jazzy, but 11 links still pointed at Humble/Foxy. Each target was
verified to resolve on the current Jazzy docs (via the ROS documentation and Tavily), including
several Jazzy reorganisations:
parameters_and_launch.rstUnderstanding-ROS2-Parameters.html→…/Understanding-ROS2-Parameters/Understanding-ROS2-Parameters.htmlparameters_and_launch.rstLaunch-Main.html→Creating-Launch-Files.html(Launch-Main.htmlno longer exists on Jazzy)parameters_and_launch.rstConcepts/Basic/About-Parameters.html(×2, humble→jazzy)publishers_and_subscribers.rstConcepts.html#quick-overview-of-ros-2-concepts→Concepts/Basic.html(anchor removed on Jazzy)publishers_and_subscribers.rstAbout-Quality-of-Service-Settings.html→Concepts/Intermediate/About-Quality-of-Service-Settings.htmlcreate_interface_package.rstAbout-ROS-Interfaces.html#field-types→Concepts/Basic/About-Interfaces.html#field-types(anchor kept — verified present)interfaces.rstAbout-ROS-Interfaces.html→Concepts/Basic/About-Interfaces.htmlpython_node_explained.rstrclpy/blob/humble/…/timer.hpp→rclpy/blob/jazzy/…/timer.hpppython_node_explained.rstdocs.ros2.org/foxy/api/rclpy/…/init_shutdown.html→docs.ros.org/en/jazzy/p/rclpy/api/execution_and_callbacks.html(the olddocs.ros2.org/<distro>/api/layout now 404s)transformations/tf2.rstdocs.ros2.org/foxy/api/tf2_ros/…Buffer.html→docs.ros.org/en/jazzy/p/tf2_ros/generated/classtf2__ros_1_1Buffer.htmlNote: the
ros2-tutorial.readthedocs.io/en/humble/…"previous version" links (inservice_servers_and_clients.rstandcreate_interface_package.rst) are intentional and were left unchanged.2. Make the Gazebo "other content" page reachable
docs/source/gazebo/other_content.rst(the Gazebo and ROS2 structure sensor/topic table + entitiesexamples) was not in any toctree, so it was unreachable. Added
gazebo/other_contentto the Gazebotoctree in
docs/source/index.rst.3. Remove three dead RST files
None of these were referenced (no
toctree,:doc:,:ref:,include, orliteralinclude), soSphinx never built them:
docker/troubleshooting.rst— its content is already inlined under Tips and troubleshooting indocker/index.rst.the_pycharm_dependencies_warning.rst— orphaned reusable snippet and it contained a dangling:ref:(PyCharm is not finding the dependencies, a label defined nowhere).the_section_is_optional.rst— orphaned reusable snippet.All changes are documentation-only; CI (
colcon build) is unaffected.Created by an AI agent (OpenHands) on behalf of the user.