Fix absolute links #385
Fix absolute links #385
Conversation
WalkthroughThe recent updates across multiple README files for the Panther robot project focus on enhancing documentation portability. By converting absolute URLs to relative paths, users can now navigate resources more easily within the project's structure, regardless of where it is hosted. This change improves usability without impacting the functionality or logic of the codebase. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Resources
User->>Documentation: Access README
Documentation->>Resources: Fetch relative path links
Resources-->>Documentation: Return resource details
Documentation-->>User: Display information
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (4)
- panther_bringup/README.md (1 hunks)
- panther_gazebo/README.md (3 hunks)
- panther_hardware_interfaces/README.md (5 hunks)
- panther_lights/README.md (1 hunks)
Files skipped from review due to trivial changes (1)
- panther_bringup/README.md
Additional context used
LanguageTool
panther_gazebo/README.md
[uncategorized] ~38-~38: You might be missing the article “the” here.
Context: ...ng Wheel Type It is possible to change Panther wheels model in simulation. All you nee...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~38-~38: You might be missing the article “the” here.
Context: ...sible to change Panther wheels model in simulation. All you need to do is to point to new ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
panther_hardware_interfaces/README.md
[typographical] ~26-~26: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
[formatting] ~26-~26: Use a comma after introducing a concessive statement.
Context: ...oller](../panther_controller) package). That said apart from the usual interface provided...(EVEN_SO_PREMIUM)
[typographical] ~101-~101: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
Markdownlint
panther_lights/README.md
163-163: null
Images should have alternate text (alt text)(MD045, no-alt-text)
164-164: null
Images should have alternate text (alt text)(MD045, no-alt-text)
165-165: null
Images should have alternate text (alt text)(MD045, no-alt-text)
166-166: null
Images should have alternate text (alt text)(MD045, no-alt-text)
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
168-168: null
Images should have alternate text (alt text)(MD045, no-alt-text)
169-169: null
Images should have alternate text (alt text)(MD045, no-alt-text)
170-170: null
Images should have alternate text (alt text)(MD045, no-alt-text)
171-171: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (6)
panther_gazebo/README.md (2)
14-14: Correct use of relative links.The change to a relative link for
simulation.launch.pyenhances portability and usability.
77-77: Correct use of relative links.The change to a relative link for the
components.yamlfile improves documentation accessibility.panther_hardware_interfaces/README.md (4)
61-61: Correct use of relative links.The change to a relative link for
panther_macro.urdf.xacroenhances documentation accessibility.
74-76: Correct use of relative links.The change to relative links for
canopen_configuration.yamlimproves documentation portability.
109-109: Correct use of relative links.The change to a relative link for
panther_macro.urdf.xacroenhances documentation accessibility.
173-173: Correct use of relative links.The change to a relative link for
CODE_STRUCTURE.mdensures consistency and improves documentation usability.
| @@ -35,7 +35,7 @@ The recommended method for launching the simulation is by utilizing the [simulat | |||
|
|
|||
| ### Changing Wheel Type | |||
|
|
|||
| It is possible to change Panther wheels model in simulation. All you need to do is to point to new wheel and controller configuration files using `wheel_config_path` and `controller_config_path` parameters. These files should be based on the default ones, i.e., [WH01_controller.yaml](https://github.com/husarion/panther_ros/panther_controller/config/WH01_controller.yaml) and [WH01.yaml](https://github.com/husarion/panther_ros/panther_description/config/WH01.yaml). | |||
| It is possible to change Panther wheels model in simulation. All you need to do is to point to new wheel and controller configuration files using `wheel_config_path` and `controller_config_path` parameters. These files should be based on the default ones, i.e., [WH01_controller.yaml](../panther_controller/config/WH01_controller.yaml) and [WH01.yaml](../panther_description/config/WH01.yaml). | |||
There was a problem hiding this comment.
Add missing article "the".
The sentence "It is possible to change Panther wheels model in simulation." is missing the article "the" before "Panther wheels model."
- It is possible to change Panther wheels model in simulation.
+ It is possible to change the Panther wheels model in simulation.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| It is possible to change Panther wheels model in simulation. All you need to do is to point to new wheel and controller configuration files using `wheel_config_path` and `controller_config_path` parameters. These files should be based on the default ones, i.e., [WH01_controller.yaml](../panther_controller/config/WH01_controller.yaml) and [WH01.yaml](../panther_description/config/WH01.yaml). | |
| It is possible to change the Panther wheels model in simulation. All you need to do is to point to new wheel and controller configuration files using `wheel_config_path` and `controller_config_path` parameters. These files should be based on the default ones, i.e., [WH01_controller.yaml](../panther_controller/config/WH01_controller.yaml) and [WH01.yaml](../panther_description/config/WH01.yaml). |
Tools
LanguageTool
[uncategorized] ~38-~38: You might be missing the article “the” here.
Context: ...ng Wheel Type It is possible to change Panther wheels model in simulation. All you nee...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~38-~38: You might be missing the article “the” here.
Context: ...sible to change Panther wheels model in simulation. All you need to do is to point to new ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
| | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400"> | | ||
| | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400"> | | ||
| | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400"> | | ||
| | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400"> | | ||
| | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> | | ||
| | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> | | ||
| | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400"> | | ||
| | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> | | ||
| | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> | |
There was a problem hiding this comment.
Add alt text to images.
The images in the table lack alt text, which is important for accessibility.
- | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400"> |
+ | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400" alt="E_STOP"> |
- | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400"> |
+ | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400" alt="READY"> |
- | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400"> |
+ | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400" alt="ERROR"> |
- | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400"> |
+ | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400" alt="MANUAL_ACTION"> |
- | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> |
+ | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400" alt="AUTONOMOUS_ACTION"> |
- | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> |
+ | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400" alt="GOAL_ACHIEVED"> |
- | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400"> |
+ | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400" alt="LOW_BATTERY"> |
- | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> |
+ | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400" alt="CRITICAL_BATTERY"> |
- | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> |
+ | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400" alt="CHARGING_BATTERY"> |Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400"> | | |
| | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400"> | | |
| | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400"> | | |
| | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400"> | | |
| | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> | | |
| | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> | | |
| | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400"> | | |
| | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> | | |
| | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> | | |
| | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400" alt="E_STOP"> | | |
| | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400" alt="READY"> | | |
| | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400" alt="ERROR"> | | |
| | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400" alt="MANUAL_ACTION"> | | |
| | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400" alt="AUTONOMOUS_ACTION"> | | |
| | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400" alt="GOAL_ACHIEVED"> | | |
| | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400" alt="LOW_BATTERY"> | | |
| | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400" alt="CRITICAL_BATTERY"> | | |
| | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400" alt="CHARGING_BATTERY"> | |
Tools
Markdownlint
163-163: null
Images should have alternate text (alt text)(MD045, no-alt-text)
164-164: null
Images should have alternate text (alt text)(MD045, no-alt-text)
165-165: null
Images should have alternate text (alt text)(MD045, no-alt-text)
166-166: null
Images should have alternate text (alt text)(MD045, no-alt-text)
167-167: null
Images should have alternate text (alt text)(MD045, no-alt-text)
168-168: null
Images should have alternate text (alt text)(MD045, no-alt-text)
169-169: null
Images should have alternate text (alt text)(MD045, no-alt-text)
170-170: null
Images should have alternate text (alt text)(MD045, no-alt-text)
171-171: null
Images should have alternate text (alt text)(MD045, no-alt-text)
| @@ -23,7 +23,7 @@ Package that implements SystemInterface from ros2_control for Panther. | |||
| [//]: # (ROS_API_NODE_DESCRIPTION_START) | |||
|
|
|||
| This package doesn't contain any standalone nodes - `PantherSystem` is a plugin loaded by the resource manager. | |||
| To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](https://github.com/husarion/panther_ros/panther_description/)) and add a controller (example configuration provided in [panther_controller](https://github.com/husarion/panther_ros/panther_controller/) package). | |||
| To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description)) and add a controller (example configuration provided in [panther_controller](../panther_controller) package). | |||
There was a problem hiding this comment.
Add missing comma.
A comma is needed after "That said" for clarity.
- That said apart from the usual interface provided by the ros2_control, this plugin also provides additional published topics and services specific for Panther.
+ That said, apart from the usual interface provided by the ros2_control, this plugin also provides additional published topics and services specific for Panther.Committable suggestion was skipped due to low confidence.
Tools
LanguageTool
[typographical] ~26-~26: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
[formatting] ~26-~26: Use a comma after introducing a concessive statement.
Context: ...oller](../panther_controller) package). That said apart from the usual interface provided...(EVEN_SO_PREMIUM)
| @@ -98,15 +98,15 @@ | |||
| [//]: # (ROS_API_NODE_DESCRIPTION_START) | |||
|
|
|||
| This package doesn't contain any standalone nodes - `PantherImuSensor` is a plugin loaded by the resource manager. | |||
| To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](https://github.com/husarion/panther_ros/tree/ros2-devel/panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](https://github.com/husarion/panther_ros/tree/ros2-devel/panther_controller/) package). | |||
| To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package). | |||
There was a problem hiding this comment.
Add missing comma.
A comma is needed after "To use this hardware interface" for clarity.
- To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package).
+ To use this hardware interface, you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package).Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package). | |
| To use this hardware interface, you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package). |
Tools
LanguageTool
[typographical] ~101-~101: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
Description
Links in
README.mdfiles are absolute and some of them don't work.Modifications
Changed absolute links in
*.mdfiles from .eg[panther_description](https://github.com/husarion/panther_ros/panther_description/)to[panther_description](../panther_description/)Summary by CodeRabbit
panther_lightsdocumentation to relative links, improving accessibility regardless of hosting environment.