Skip to content

Commit d8c55c1

Browse files
authored
Refactor documentation and release Jazzy (#321)
* Moved /docs/robots to /docs_robots and made it unversioned in preparation for Jazzy release * Moved ROS 1 robot details under docs_robots/legacy/ros1_robots so that we don't lose those old details now that versioning is removed on Robots * Created ROS 2 Jazzy release * Removed deprecated files under /docs now that the jazzy release is created
1 parent e102fbb commit d8c55c1

File tree

736 files changed

+189
-13030
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

736 files changed

+189
-13030
lines changed

docs/components/_tutorials_link.mdx renamed to components/_tutorials_link.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ These tutorials assume that you are comfortable working with [ROS](https://docs.
99

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

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

1414
## Software Setup
1515

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

2020
## Using your Robot
2121

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

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

2828
## Advanced Topics
2929

30-
- [Configuring Network Bridge](../ros/networking/computer_setup.mdx)
30+
- [Configuring Network Bridge](/docs/ros/networking/computer_setup)

components/maintenance/wd_ssd_critical_update.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Failure to perform the firmware update could result in permanent failure of the
2626

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

29-
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),
29+
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),
3030
[ROS 2 backup details here](/docs/ros/installation/upgrading#saving-a-hard-drive-image)).
3131
1. Remove the SSD from the robot. Ensure that you use an ESD grounded wrist strap when handling SSD or PCB components.
3232
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).

components/supported_sensors.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,26 @@ sensors that have been validated by Clearpath.
99

1010
| Sensor | Type | Installation | Driver |
1111
| :----------------------------------------------------------------------------------- | :----------- | :----------- | :------------------------------------------------------------------------------------------ |
12-
| [SICK LMS-111/LMS-151](../robots/accessories/sensors/lidar_2d/sick_lms111) | 2D Lidar | Debian | [LMS1xx](https://github.com/clearpathrobotics/LMS1xx) |
13-
| [Hokuyo UST10-LX](../robots/accessories/sensors/lidar_2d/hokuyo_ust10_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
14-
| [Hokuyo UST20-LX](../robots/accessories/sensors/lidar_2d/hokuyo_ust20_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
15-
| [Hokuyo UST30-LX](../robots/accessories/sensors/lidar_2d/hokuyo_ust30_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
16-
| [MicroStrain 3DM-GX5](../robots/accessories/sensors/imu/microstrain_3dm_gx5) | IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
17-
| [MicroStrain 3DM-GQ7](../robots/accessories/sensors/gps/microstrain_gq7) | GPS/IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
18-
| [Redshift Labs UM7](../robots/accessories/sensors/imu/redshift_labs_um7) | IMU | Debian | [um7](https://github.com/ros-drivers/um7/tree/ros2) |
12+
| [SICK LMS-111/LMS-151](/docs_robots/accessories/sensors/lidar_2d/sick_lms111) | 2D Lidar | Debian | [LMS1xx](https://github.com/clearpathrobotics/LMS1xx) |
13+
| [Hokuyo UST10-LX](/docs_robots/accessories/sensors/lidar_2d/hokuyo_ust10_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
14+
| [Hokuyo UST20-LX](/docs_robots/accessories/sensors/lidar_2d/hokuyo_ust20_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
15+
| [Hokuyo UST30-LX](/docs_robots/accessories/sensors/lidar_2d/hokuyo_ust30_lx) | 2D Lidar | Debian | [urg_node](https://github.com/ros-drivers/urg_node) |
16+
| [MicroStrain 3DM-GX5](/docs_robots/accessories/sensors/imu/microstrain_3dm_gx5) | IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
17+
| [MicroStrain 3DM-GQ7](/docs_robots/accessories/sensors/gps/microstrain_gq7) | GPS/IMU | Debian | [microstrain_intertial](https://github.com/LORD-MicroStrain/microstrain_inertial/tree/ros2) |
18+
| [Redshift Labs UM7](/docs_robots/accessories/sensors/imu/redshift_labs_um7) | IMU | Debian | [um7](https://github.com/ros-drivers/um7/tree/ros2) |
1919
| CH Robotics UM6 | IMU | Debian | [um7](https://github.com/ros-drivers/um7/tree/ros2) |
20-
| [Velodyne Puck](../robots/accessories/sensors/lidar_3d/velodyne_puck) | 3D Lidar | Debian | [velodyne](https://github.com/ros-drivers/velodyne/tree/ros2) |
21-
| [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) |
20+
| [Velodyne Puck](/docs_robots/accessories/sensors/lidar_3d/velodyne_puck) | 3D Lidar | Debian | [velodyne](https://github.com/ros-drivers/velodyne/tree/ros2) |
21+
| [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) |
2222
| NovAtel SMART6 and SMART7 | GPS | Debian | [nmea_navsat_driver](https://github.com/ros-drivers/nmea_navsat_driver/tree/ros2) |
23-
| [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) |
24-
| [Axis F1035-E](../robots/accessories/sensors/cameras/axis_f1035_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
25-
| [Axis M5525-E](../robots/accessories/sensors/cameras/axis_m5525_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
26-
| [Axis Q6225-LE-E](../robots/accessories/sensors/cameras/axis_q6225_le) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
27-
| [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) |
28-
| [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) |
29-
| [Intel Realsense D435](../robots/accessories/sensors/cameras/realsense_d435) | Depth Camera | Debian | [realsense-ros](https://github.com/IntelRealSense/realsense-ros/tree/ros2-development) |
30-
| [Luxonis OAK-D](../robots/accessories/sensors/cameras/luxonis_oakd) | Depth Camera | Debian | [depthai-ros](https://github.com/luxonis/depthai-ros.git) |
31-
| [Stereolabs Zed 2](../robots/accessories/sensors/cameras/stereolabs_zed_2) | Depth Camera | Source | [zed-ros2-wrapper](https://github.com/stereolabs/zed-ros2-wrapper.git) |
23+
| [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) |
24+
| [Axis F1035-E](/docs_robots/accessories/sensors/cameras/axis_f1035_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
25+
| [Axis M5525-E](/docs_robots/accessories/sensors/cameras/axis_m5525_e) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
26+
| [Axis Q6225-LE-E](/docs_robots/accessories/sensors/cameras/axis_q6225_le) | Camera | Debian | [axis_camera](https://github.com/ros-drivers/axis_camera.git) |
27+
| [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) |
28+
| [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) |
29+
| [Intel Realsense D435](/docs_robots/accessories/sensors/cameras/realsense_d435) | Depth Camera | Debian | [realsense-ros](https://github.com/IntelRealSense/realsense-ros/tree/ros2-development) |
30+
| [Luxonis OAK-D](/docs_robots/accessories/sensors/cameras/luxonis_oakd) | Depth Camera | Debian | [depthai-ros](https://github.com/luxonis/depthai-ros.git) |
31+
| [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) |
3232

3333
:::note
3434

components/using_ros.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Robot Operating System (ROS) is an extensible framework for controlling and working with robotic systems.
22
Clearpath Robotics recommends using ROS with your robot. If this is your first time using ROS, it is strongly
3-
recommended to run through our series of [ROS tutorials](../../../ros) to learn
3+
recommended to run through our series of [ROS tutorials](/docs/ros) to learn
44
the basics of ROS.

docs/robots/accessories/add-ons/controllers.mdx

Lines changed: 0 additions & 104 deletions
This file was deleted.

docs/robots/accessories/sensors/imu/microstrain_3dm_gx5.mdx

Lines changed: 0 additions & 77 deletions
This file was deleted.

0 commit comments

Comments
 (0)