iRobotEducation / irobot_create_msgs

Action, message and service definitions used by the iRobot® Create® Platform
BSD 3-Clause "New" or "Revised" License
31 stars 8 forks source link

Broken Link in the README #16

Closed CursedRock17 closed 6 months ago

CursedRock17 commented 6 months ago

Bug report

Steps to reproduce issue

Click on the link to have ROS interfaces explained, found at this line in the README: 

https://github.com/iRobotEducation/irobot_create_msgs/blob/rolling/README.md?plain=1#L5

Expected behavior

Have said interfaces explained

Actual behavior

The user gets taken to 404 link on ROS Index

Additional information

Odds are this was supposed to link back to the docs, something as easy as:

would probably do the trick, but if the user needs more information they could use the starting tutorials, starting here:

shamlian commented 6 months ago

Thanks for the report. This link used to be active. Checking the Wayback Machine shows it last archived about a year ago. Searching for some the text from this archived link, I see that the page seems to have moved to https://docs.ros.org/en/rolling/Concepts/Basic/About-Interfaces.html, but that page also no longer appears to be available, having last been archived in Dec. 2023. Interestingly, this link is linked to from one of the links you suggested. I am going to check with the ROS 2 devs about whether or not this page removal was intentional.

shamlian commented 6 months ago

https://docs.ros.org/en/rolling/Concepts/Basic/About-Interfaces.html is up now; I will update the README to point to this URL.