Skip to content

Commit fd67069

Browse files
authored
Normalize wiki markdown filenames and fix markdown rendering/link issues (#259)
Improves wiki content consistency and markdown reliability by normalizing filenames/slugs and fixing markdown/math formatting issues. - Renamed wiki markdown files to lowercase kebab-case for consistency. - Updated internal wiki/navigation references to match renamed slugs. - Corrected markdown formatting issues in planning content (especially Frenet/math-heavy sections). - Improved equation/text rendering compatibility in markdown pages. - Fixed malformed markdown link patterns in affected pages.
1 parent dfa039f commit fd67069

53 files changed

Lines changed: 148 additions & 166 deletions

Some content is hidden

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

_data/navigation.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ wiki:
2424
- title: Subsystem Interface Modeling
2525
url: /wiki/system-design-development/subsystem-interface-modeling/
2626
- title: In Loop Testing
27-
url: /wiki/system-design-development/In-Loop-Testing/
27+
url: /wiki/system-design-development/in-loop-testing/
2828
- title: How to design a robotic state machine
2929
url: /wiki/system-design-development/how-to-design-a-robotic-state-machine/
3030
- title: Project Management
@@ -50,7 +50,7 @@ wiki:
5050
- title: Hello Robot Stretch RE1
5151
url: /wiki/common-platforms/hello-robot
5252
- title: Husky Interfacing Procedure
53-
url: /wiki/common-platforms/husky_interfacing_and_communication/
53+
url: /wiki/common-platforms/husky-interfacing-and-communication/
5454
- title: Interfacing with the Nvidia Orin
5555
url: /wiki/common-platforms/interfacing-with-nvidia-orin/
5656
- title: Khepera 4
@@ -141,7 +141,7 @@ wiki:
141141
- title: Thermal Cameras
142142
url: /wiki/sensing/thermal-cameras/
143143
- title: Tracking vehicles using a static traffic camera
144-
url: /wiki/sensing/trajectory_extraction_static_camera/
144+
url: /wiki/sensing/trajectory-extraction-static-camera/
145145
- title: Actuation
146146
url: /wiki/actuation/
147147
children:
@@ -156,9 +156,9 @@ wiki:
156156
- title: Vedder Electronic Speed Controller
157157
url: /wiki/actuation/vedder-electronic-speed-controller/
158158
- title: Pure Pursuit Controller for Skid Steering
159-
url: /wiki/actuation/Pure-Pursuit-Controller-for-Skid-Steering-Robot.md
159+
url: /wiki/actuation/pure-pursuit-controller-for-skid-steering-robot.md
160160
- title: MoveIt Motion Planning and HEBI Actuator Setup and Integration
161-
url: /wiki/actuation/moveit-and-HEBI-integration.md
161+
url: /wiki/actuation/moveit-and-hebi-integration.md
162162
- title: Model Predictive Control Introduction and Setup
163163
url: /wiki/actuation/model-predictive-control/
164164
- title: Task Prioritization Control for Advanced Manipulator Control
@@ -198,7 +198,7 @@ wiki:
198198
- title: Visual Servoing
199199
url: /wiki/state-estimation/visual-servoing/
200200
- title: Cartographer SLAM ROS Integration
201-
url: /wiki/state-estimation/Cartographer-ROS-Integration/
201+
url: /wiki/state-estimation/cartographer-ros-integration/
202202
- title: External Position Estimation using OptiTrack Motion Capture System
203203
url: /wiki/state-estimation/optitrack-motion-capture/
204204
- title: Programming
@@ -239,13 +239,13 @@ wiki:
239239
url: /wiki/simulation/
240240
children:
241241
- title: Building a Light Weight Custom Simulator
242-
url: /wiki/simulation/Building-a-Light-Weight-Custom-Simulator/
242+
url: /wiki/simulation/building-a-light-weight-custom-simulator/
243243
- title: Design considerations for ROS architectures
244244
url: /wiki/simulation/Design-considerations-for-ROS-architectures
245245
- title: Spawning and Controlling Vehicles in CARLA
246246
url: /wiki/simulation/Spawning-and-Controlling-Vehicles-in-CARLA
247247
- title: NDT Matching with Autoware
248-
url: /wiki/simulation/NDT-Matching-with-Autoware/
248+
url: /wiki/simulation/ndt-matching-with-autoware/
249249
- title: An Introduction to Isaac Sim
250250
url: /wiki/simulation/an-introduction-to-isaac-sim/
251251
- title: Simulating UGVs in Unity
@@ -260,7 +260,7 @@ wiki:
260260
- title: micro-ROS for ROS2 on Microcontrollers
261261
url: /wiki/interfacing/microros-for-ros2-on-microcontrollers/
262262
- title: ROS 1 - ROS 2 Bridge
263-
url: /wiki/interfacing/ros1_ros2_bridge/
263+
url: /wiki/interfacing/ros1-ros2-bridge/
264264
- title: Computing
265265
url: /wiki/computing/
266266
children:
@@ -290,7 +290,7 @@ wiki:
290290
- title: CubePro
291291
url: /wiki/fabrication/cube-pro/
292292
- title: Fabrication Considerations for 3D printing
293-
url: /wiki/fabrication/fabrication_considerations_for_3D_printing/
293+
url: /wiki/fabrication/fabrication-considerations-for-3d-printing/
294294
- title: Machining & Prototyping
295295
url: /wiki/fabrication/machining-prototyping/
296296
- title: MakerBot Replicator 2x
@@ -300,7 +300,7 @@ wiki:
300300
- title: Rapid Prototyping
301301
url: /wiki/fabrication/rapid-prototyping/
302302
- title: Series A Pro Printer
303-
url: /wiki/fabrication/series-A-pro/
303+
url: /wiki/fabrication/series-a-pro/
304304
- title: Sheet Metal Fabrication
305305
url: /wiki/fabrication/sheet-metal-guidelines/
306306
- title: Soldering
@@ -346,7 +346,7 @@ wiki:
346346
- title: Code Editors - Introduction to VS Code and Vim
347347
url: /wiki/tools/code-editors-Introduction-to-vs-code-and-vim/
348348
- title: Qtcreator UI development with ROS
349-
url: /wiki/tools/Qtcreator-ros/
349+
url: /wiki/tools/qt-creator-ros/
350350
- title: Tutorial on Using USB Compute Sticks
351351
url: /wiki/tools/usb-compute-sticks/
352352
- title: Datasets
@@ -362,7 +362,7 @@ wiki:
362362
- title: Planning Overview
363363
url: /wiki/planning/planning-overview/
364364
- title: A* Planner Implementation Guide
365-
url: /wiki/planning/astar_planning_implementation_guide/
365+
url: /wiki/planning/astar-planning-implementation-guide/
366366
- title: Coverage Planner Implementation Guide
367367
url: /wiki/planning/coverage-planning-implementation-guide/
368368
- title: Resolved Rates

wiki/actuation/__all_subsections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ In most of the applications for a DC geared motor speed control or position cont
439439
In order to use feedback control, we need information about the state of the motor. This is achieved through the use of encoders mounted on the motor shaft. Typically, data from this encoder is fed into a microcontroller, such as an Arduino. The microcontroller would need to have a code for PID control. Another easier option would be to use a motor controller which has the ability to read data from the encoder. One such controller is Pololu Jrk 21v3 USB Motor Controller with Feedback. More details about this component can be found [here](https://www.pololu.com/product/1392.).
440440

441441

442-
/wiki/actuation/moveit-and-HEBI-integration/
442+
/wiki/actuation/moveit-and-hebi-integration/
443443
---
444444
# Jekyll 'Front Matter' goes here. Most are set by default, and should NOT be
445445
# overwritten except in special circumstances.
@@ -709,7 +709,7 @@ If your sensor readings are very noise you might want to consider adding a Kalma
709709
Finally, you can write your own PID software using [this guide](http://brettbeauregard.com/blog/2011/04/improving-the-beginners-pid-introduction/). You might want to do this if you want to add custom features or just want to learn more about controls. Only recommended for advanced users.
710710

711711

712-
/wiki/actuation/Pure-Pursuit-Controller-for-Skid-Steering-Robot/
712+
/wiki/actuation/pure-pursuit-controller-for-skid-steering-robot/
713713
---
714714
date: 2020-04-10
715715
Title: Pure-Pursuit based Controller for Skid Steering Robot

wiki/actuation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ The "Controls & Actuation" section provides a detailed guide to implementing and
2121
- **[Motor Controller with Feedback](/wiki/actuation/motor-controller-feedback/)**
2222
Introduces motor controllers with encoder feedback, highlighting the Pololu Jrk 21v3 USB Motor Controller as an example.
2323

24-
- **[MoveIt Motion Planning and HEBI Actuator Setup and Integration](/wiki/actuation/moveit-and-HEBI-integration/)**
24+
- **[MoveIt Motion Planning and HEBI Actuator Setup and Integration](/wiki/actuation/moveit-and-hebi-integration/)**
2525
Outlines using MoveIt in ROS for robotic motion planning and integrating it with HEBI actuators for hardware execution.
2626

2727
- **[PID Control on Arduino](/wiki/actuation/pid-control-arduino/)**
2828
Explains implementing PID control on Arduino platforms, including tips for tuning and integrating Kalman filters for noisy sensors.
2929

30-
- **[Pure-Pursuit Based Controller for Skid Steering Robots](/wiki/actuation/Pure-Pursuit-Controller-for-Skid-Steering-Robot/)**
30+
- **[Pure-Pursuit Based Controller for Skid Steering Robots](/wiki/actuation/pure-pursuit-controller-for-skid-steering-robot/)**
3131
Covers the Pure-Pursuit algorithm for trajectory tracking in skid-steering robots, including implementation steps and constraints.
3232

3333
- **[Task Prioritization Control for Advanced Manipulator Control](/wiki/actuation/task-prioritization-control/)**
File renamed without changes.

wiki/actuation/Pure-Pursuit-Controller-for-Skid-Steering-Robot.md renamed to wiki/actuation/pure-pursuit-controller-for-skid-steering-robot.md

File renamed without changes.

wiki/common-platforms/__all_subsections.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ Using the above tutorials, one can get started easily with the HelloNode and Too
555555
- [Tool Share examples](https://github.com/hello-robot/stretch_tool_share)
556556
557557
558-
/wiki/common-platforms/husky_interfacing_and_communication/
558+
/wiki/common-platforms/husky-interfacing-and-communication/
559559
---
560560
date: 2019-05-14
561561
title: Husky Interfacing and Communication
@@ -897,7 +897,7 @@ For instance, in the [Husky](https://github.com/husky/husky/tree/humble-devel) r
897897
This tutorial aims to guide you through the process of setting up the ROS 1 navigation stack on the Clearpath Husky and seamlessly connecting it to ROS 2. It assumes a foundational understanding of both ROS 1 and ROS 2.
898898
899899
## ROS 1 - ROS 2 Bridge
900-
To configure the Clearpath Husky hardware, we will be using the [husky_robot](https://github.com/husky/husky_robot) repository. This repository contains the ROS 1 packages for the Husky, including the navigation stack. To connect the ROS 1 packages to ROS 2, we will be using the [ros1_bridge](https://github.com/ros2/ros1_bridge) package. Detailed instruction on how to setup this is provided in [this tutorial](https://roboticsknowledgebase.com/wiki/interfacing/ros1_ros2_bridge/) on the Robotics Knowledgebase. Once the bridge is established, we can proceed to configure the Husky using the following steps.
900+
To configure the Clearpath Husky hardware, we will be using the [husky_robot](https://github.com/husky/husky_robot) repository. This repository contains the ROS 1 packages for the Husky, including the navigation stack. To connect the ROS 1 packages to ROS 2, we will be using the [ros1_bridge](https://github.com/ros2/ros1_bridge) package. Detailed instruction on how to setup this is provided in [this tutorial](https://roboticsknowledgebase.com/wiki/interfacing/ros1-ros2-bridge/) on the Robotics Knowledgebase. Once the bridge is established, we can proceed to configure the Husky using the following steps.
901901
```
902902
# Install Husky Packages
903903
apt-get update && apt install ros-noetic-husky* -y
@@ -1280,7 +1280,7 @@ This tutorial provides a step-by-step guide to configure the Clearpath Husky for
12801280
It is recommended to read the [Nav2 documentation](https://navigation.ros.org/index.html) to understand the Nav2 stack in detail. The [Nav2 tutorials](https://navigation.ros.org/getting_started/index.html) are also a good place to start.
12811281
12821282
## See Also:
1283-
- [ROS1 - ROS2 Bridge](https://roboticsknowledgebase.com/wiki/interfacing/ros1_ros2_bridge/)
1283+
- [ROS1 - ROS2 Bridge](https://roboticsknowledgebase.com/wiki/interfacing/ros1-ros2-bridge/)
12841284
12851285
## Further Readings:
12861286
- [Nav2 First Time Setup](https://navigation.ros.org/setup_guides/index.html)

wiki/common-platforms/husky_interfacing_and_communication.md renamed to wiki/common-platforms/husky-interfacing-and-communication.md

File renamed without changes.

wiki/common-platforms/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ We encourage contributions to further enhance the knowledge base in this section
3535
- **[Interfacing with the Nvidia Orin](/wiki/common-platforms/interfacing-with-nvidia-orin/)**
3636
A comprehensive guide to using the Nvidia Jetson AGX Orin for robotics. Covers power delivery, GPIO pinouts, high-speed interfaces like USB and Ethernet, and debugging tools for reliable sensor integration.
3737

38-
- **[Husky Interfacing and Communication](/wiki/common-platforms/husky_interfacing_and_communication/)**
38+
- **[Husky Interfacing and Communication](/wiki/common-platforms/husky-interfacing-and-communication/)**
3939
Discusses how to set up communication with the Clearpath Husky robot, including hardware setup and localization using GPS, IMU, and odometry.
4040

4141
- **[Khepera 4 Robot Guide](/wiki/common-platforms/khepera4/)**

wiki/common-platforms/ros/ros-intro.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ Actually, ROS is not an operating system but a meta operating system, which mean
2525

2626
ROS is useless without knowing how it works. Merely reading through the tutorials are not enough; this cannot be stressed enough. Learning ROS takes time and effort, so when going through the tutorials, try to understand what you are seeing, and make sure you follow along by Typing the example code, and run each tutorial to learn what is happening.
2727

28-
One of the most important package in ROS is [navigation stack](ros-navigation). Here are several topics of it covered in this directory for reference.
28+
One of the most important package in ROS is [navigation stack](ros-navigation). Here are several topics of it covered in this wiki for reference.
2929
1. [Global Planner](ros-global-planner.md)
30-
2. [Local Planner](ros-local-planner)
31-
3. [Costmap](ros-cost-maps)
32-
4. [Mapping and Localization](ros-mapping-localization)
33-
5. [Motion Server](ros-motion-server-framework)
30+
2. [Costmap](ros-cost-maps)
31+
3. [Mapping and Localization](ros-mapping-localization)
32+
4. [Motion Server](ros-motion-server-framework)

wiki/common-platforms/ros2-navigation-for-clearpath-husky.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For instance, in the [Husky](https://github.com/husky/husky/tree/humble-devel) r
1010
This tutorial aims to guide you through the process of setting up the ROS 1 navigation stack on the Clearpath Husky and seamlessly connecting it to ROS 2. It assumes a foundational understanding of both ROS 1 and ROS 2.
1111

1212
## ROS 1 - ROS 2 Bridge
13-
To configure the Clearpath Husky hardware, we will be using the [husky_robot](https://github.com/husky/husky_robot) repository. This repository contains the ROS 1 packages for the Husky, including the navigation stack. To connect the ROS 1 packages to ROS 2, we will be using the [ros1_bridge](https://github.com/ros2/ros1_bridge) package. Detailed instruction on how to setup this is provided in [this tutorial](https://roboticsknowledgebase.com/wiki/interfacing/ros1_ros2_bridge/) on the Robotics Knowledgebase. Once the bridge is established, we can proceed to configure the Husky using the following steps.
13+
To configure the Clearpath Husky hardware, we will be using the [husky_robot](https://github.com/husky/husky_robot) repository. This repository contains the ROS 1 packages for the Husky, including the navigation stack. To connect the ROS 1 packages to ROS 2, we will be using the [ros1_bridge](https://github.com/ros2/ros1_bridge) package. Detailed instruction on how to setup this is provided in [this tutorial](https://roboticsknowledgebase.com/wiki/interfacing/ros1-ros2-bridge/) on the Robotics Knowledgebase. Once the bridge is established, we can proceed to configure the Husky using the following steps.
1414
```
1515
# Install Husky Packages
1616
apt-get update && apt install ros-noetic-husky* -y
@@ -393,7 +393,7 @@ This tutorial provides a step-by-step guide to configure the Clearpath Husky for
393393
It is recommended to read the [Nav2 documentation](https://navigation.ros.org/index.html) to understand the Nav2 stack in detail. The [Nav2 tutorials](https://navigation.ros.org/getting_started/index.html) are also a good place to start.
394394

395395
## See Also:
396-
- [ROS1 - ROS2 Bridge](https://roboticsknowledgebase.com/wiki/interfacing/ros1_ros2_bridge/)
396+
- [ROS1 - ROS2 Bridge](https://roboticsknowledgebase.com/wiki/interfacing/ros1-ros2-bridge/)
397397

398398
## Further Readings:
399399
- [Nav2 First Time Setup](https://navigation.ros.org/setup_guides/index.html)

0 commit comments

Comments
 (0)