Skip to content

Refactor documentation and release Jazzy #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 25, 2025
Merged

Refactor documentation and release Jazzy #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
db5265e
Moved /docs/robots to /docs_robots and made it unversioned in prepara…
jhiggins-cpr Mar 20, 2025
4d09473
Move ROS 1 robot details under docs_robots/legacy/ros1_robots so that…
jhiggins-cpr Mar 20, 2025
abf3c89
Fix broken links
jhiggins-cpr Mar 20, 2025
dbcff0f
Created ROS 2 Jazzy release
jhiggins-cpr Mar 20, 2025
cba3a4a
Remove deprecated files under /docs now that the jazzy release is cre…
jhiggins-cpr Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 8 additions & 8 deletions docs/components/_tutorials_link.mdx → components/_tutorials_link.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ These tutorials assume that you are comfortable working with [ROS](https://docs.

You can view all topics that are active using `ros2 topic list`.

For a general list of topics and descriptions see the [Clearpath API](../ros/api/platform_api.mdx)
For a general list of topics and descriptions see the [Clearpath API](/docs/ros/api/platform_api)

## Software Setup

- [Robot Software](../ros/installation/robot.mdx)
- [Offboard Computer](../ros/installation/offboard_pc.mdx)
- [PS4 Joystick Controller (if applicable)](../ros/installation/controller.mdx)
- [Robot Software](/docs/ros/installation/robot)
- [Offboard Computer](/docs/ros/installation/offboard_pc)
- [PS4 Joystick Controller (if applicable)](/docs/ros/installation/controller)

## Using your Robot

The following tutorials are recommended to get to know your robot:

- [Driving your Robot](../ros/tutorials/driving.mdx)
- [Simulating your Robot](../ros/tutorials/simulator/overview.mdx)
- [Navigating](../ros/tutorials/navigation_demos/overview.mdx)
- [Driving your Robot](/docs/ros/tutorials/driving)
- [Simulating your Robot](/docs/ros/tutorials/simulator/overview)
- [Navigating](/docs/ros/tutorials/navigation_demos/overview)

## Advanced Topics

- [Configuring Network Bridge](../ros/networking/computer_setup.mdx)
- [Configuring Network Bridge](/docs/ros/networking/computer_setup)
0 ...s/maintenance/_wd_ssd_critical_update.mdx → ...s/maintenance/_wd_ssd_critical_update.mdx
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion components/maintenance/wd_ssd_critical_update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Failure to perform the firmware update could result in permanent failure of the

#### How to update the firmware on affected SSDs

1. Create an OS image backup of the SSD ([ROS 1 backup details here](/docs/ros1noetic/robots/outdoor_robots/husky/tutorials_husky#performing-a-backup),
1. Create an OS image backup of the SSD ([ROS 1 backup details here](/docs_robots/legacy/ros1_robots/outdoor_robots/husky/tutorials_husky#performing-a-backup),
[ROS 2 backup details here](/docs/ros/installation/upgrading#saving-a-hard-drive-image)).
1. Remove the SSD from the robot. Ensure that you use an ESD grounded wrist strap when handling SSD or PCB components.
1. Use a USB SSD dock and a Windows computer to perform the update by [following the vendor's instructions](https://support-en.sandisk.com/app/answers/detailweb/a_id/50208#subject2).
Expand Down
36 changes: 18 additions & 18 deletions components/supported_sensors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,26 @@ sensors that have been validated by Clearpath.

| Sensor | Type | Installation | Driver |
| :----------------------------------------------------------------------------------- | :----------- | :----------- | :------------------------------------------------------------------------------------------ |
| [SICK LMS-111/LMS-151](../robots/accessories/sensors/lidar_2d/sick_lms111) | 2D Lidar | Debian | [LMS1xx](https://github.com/clearpathrobotics/LMS1xx) |
| [Hokuyo UST10-LX](../robots/accessories/sensors/lidar_2d/hokuyo_ust10_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
| [Hokuyo UST20-LX](../robots/accessories/sensors/lidar_2d/hokuyo_ust20_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
| [Hokuyo UST30-LX](../robots/accessories/sensors/lidar_2d/hokuyo_ust30_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
| [MicroStrain 3DM-GX5](../robots/accessories/sensors/imu/microstrain_3dm_gx5) | IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
| [MicroStrain 3DM-GQ7](../robots/accessories/sensors/gps/microstrain_gq7) | GPS/IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
| [Redshift Labs UM7](../robots/accessories/sensors/imu/redshift_labs_um7) | IMU | Debian | [um7](https://github.com/ros-drivers/um7/tree/ros2) |
| [SICK LMS-111/LMS-151](/docs_robots/accessories/sensors/lidar_2d/sick_lms111) | 2D Lidar | Debian | [LMS1xx](https://github.com/clearpathrobotics/LMS1xx) |
| [Hokuyo UST10-LX](/docs_robots/accessories/sensors/lidar_2d/hokuyo_ust10_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
| [Hokuyo UST20-LX](/docs_robots/accessories/sensors/lidar_2d/hokuyo_ust20_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
| [Hokuyo UST30-LX](/docs_robots/accessories/sensors/lidar_2d/hokuyo_ust30_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
| [MicroStrain 3DM-GX5](/docs_robots/accessories/sensors/imu/microstrain_3dm_gx5) | IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
| [MicroStrain 3DM-GQ7](/docs_robots/accessories/sensors/gps/microstrain_gq7) | GPS/IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
| [Redshift Labs UM7](/docs_robots/accessories/sensors/imu/redshift_labs_um7) | IMU | Debian | [um7](https://github.com/ros-drivers/um7/tree/ros2) |
| CH Robotics UM6 | IMU | Debian | [um7](https://github.com/ros-drivers/um7/tree/ros2) |
| [Velodyne Puck](../robots/accessories/sensors/lidar_3d/velodyne_puck) | 3D Lidar | Debian | [velodyne](https://github.com/ros-drivers/velodyne/tree/ros2) |
| [Garmin GPS 18x](../robots/accessories/sensors/gps/garmin_gps_18x) | GPS | Debian | [nmea_navsat_driver](https://github.com/ros-drivers/nmea_navsat_driver/tree/ros2) |
| [Velodyne Puck](/docs_robots/accessories/sensors/lidar_3d/velodyne_puck) | 3D Lidar | Debian | [velodyne](https://github.com/ros-drivers/velodyne/tree/ros2) |
| [Garmin GPS 18x](/docs_robots/accessories/sensors/gps/garmin_gps_18x) | GPS | Debian | [nmea_navsat_driver](https://github.com/ros-drivers/nmea_navsat_driver/tree/ros2) |
| NovAtel SMART6 and SMART7 | GPS | Debian | [nmea_navsat_driver](https://github.com/ros-drivers/nmea_navsat_driver/tree/ros2) |
| [Swift Navigation Duro](../robots/accessories/sensors/gps/swift_navigation_duro) | GPS | Source | [duro_gps_driver](https://github.com/szenergy/duro_gps_driver/tree/ros2-humble) |
| [Axis F1035-E](../robots/accessories/sensors/cameras/axis_f1035_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
| [Axis M5525-E](../robots/accessories/sensors/cameras/axis_m5525_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
| [Axis Q6225-LE-E](../robots/accessories/sensors/cameras/axis_q6225_le) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
| [Flir Blackfly S](../robots/accessories/sensors/cameras/flir_blackfly_s) | Camera | Debian | [flir_camera_driver](https://github.com/ros-drivers/flir_camera_driver/tree/humble-devel) |
| [Flir Ladybug 5P](../robots/accessories/sensors/cameras/flir_ladybug5p) | Camera | Debian | [flir_camera_driver](https://github.com/ros-drivers/flir_camera_driver/tree/humble-devel) |
| [Intel Realsense D435](../robots/accessories/sensors/cameras/realsense_d435) | Depth Camera | Debian | [realsense-ros](https://github.com/IntelRealSense/realsense-ros/tree/ros2-development) |
| [Luxonis OAK-D](../robots/accessories/sensors/cameras/luxonis_oakd) | Depth Camera | Debian | [depthai-ros](https://github.com/luxonis/depthai-ros.git) |
| [Stereolabs Zed 2](../robots/accessories/sensors/cameras/stereolabs_zed_2) | Depth Camera | Source | [zed-ros2-wrapper](https://github.com/stereolabs/zed-ros2-wrapper.git) |
| [Swift Navigation Duro](/docs_robots/accessories/sensors/gps/swift_navigation_duro) | GPS | Source | [duro_gps_driver](https://github.com/szenergy/duro_gps_driver/tree/ros2-humble) |
| [Axis F1035-E](/docs_robots/accessories/sensors/cameras/axis_f1035_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
| [Axis M5525-E](/docs_robots/accessories/sensors/cameras/axis_m5525_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
| [Axis Q6225-LE-E](/docs_robots/accessories/sensors/cameras/axis_q6225_le) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
| [Flir Blackfly S](/docs_robots/accessories/sensors/cameras/flir_blackfly_s) | Camera | Debian | [flir_camera_driver](https://github.com/ros-drivers/flir_camera_driver/tree/humble-devel) |
| [Flir Ladybug 5P](/docs_robots/accessories/sensors/cameras/flir_ladybug5p) | Camera | Debian | [flir_camera_driver](https://github.com/ros-drivers/flir_camera_driver/tree/humble-devel) |
| [Intel Realsense D435](/docs_robots/accessories/sensors/cameras/realsense_d435) | Depth Camera | Debian | [realsense-ros](https://github.com/IntelRealSense/realsense-ros/tree/ros2-development) |
| [Luxonis OAK-D](/docs_robots/accessories/sensors/cameras/luxonis_oakd) | Depth Camera | Debian | [depthai-ros](https://github.com/luxonis/depthai-ros.git) |
| [Stereolabs Zed 2](/docs_robots/accessories/sensors/cameras/stereolabs_zed_2) | Depth Camera | Source | [zed-ros2-wrapper](https://github.com/stereolabs/zed-ros2-wrapper.git) |

:::note

Expand Down
2 changes: 1 addition & 1 deletion components/using_ros.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Robot Operating System (ROS) is an extensible framework for controlling and working with robotic systems.
Clearpath Robotics recommends using ROS with your robot. If this is your first time using ROS, it is strongly
recommended to run through our series of [ROS tutorials](../../../ros) to learn
recommended to run through our series of [ROS tutorials](/docs/ros) to learn
the basics of ROS.
104 changes: 0 additions & 104 deletions docs/robots/accessories/add-ons/controllers.mdx
View file
Open in desktop

This file was deleted.

77 changes: 0 additions & 77 deletions docs/robots/accessories/sensors/imu/microstrain_3dm_gx5.mdx
View file
Open in desktop

This file was deleted.

Loading