Skip to content

Commit 0ceacb8

Browse files
committed
0-13-development: Ran Prettier
1 parent 129d198 commit 0ceacb8

31 files changed

+2894
-2855
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -376,27 +376,33 @@ Links to headings must not include an extra slash between the name of the page a
376376
<img src="/static/img/readme_images/readme_solidworks_image_4.png" width="800"/>
377377

378378
## Mermaid Diagrams
379+
379380
Mermaid is a JavaScript based diagram generator that uses Markdown for descriptions and is available to docusaurus through a [plug-in](https://docusaurus.io/docs/next/markdown-features/diagrams).
380381

381382
To get started with Mermaid diagrams, use their [live tool](https://mermaid.live/edit). The live viewing tool is useful to explore the various diagrams using their readily available templates.
382-
>> Currently, we are on version 2.4.3 of the Mermaid plug-in. Therefore, not all of the templates in the live version are available.
383+
384+
> > Currently, we are on version 2.4.3 of the Mermaid plug-in. Therefore, not all of the templates in the live version are available.
383385
384386
Although Mermaid is more complicated to use than other tools, it is easy to version and outputs HTML objects; the resulting diagrams can include links and the text within it is searchable. Additionally, HTML tags can be included within the diagrams for further customization. Refer to the [Mermaid Documentation](https://mermaid.js.org/intro/getting-started.html) for more details on the diagram descriptions.
385387

386388
### Themes
389+
387390
In the [Docusaurus configuration file](./docusaurus.config.js), we have defined the site-wide themes for the Mermaid diagrams. Mermaid offers a choice of five different themes to choose from. There is a way to call the `mermaidAPI` to set a customized site-wide theme, however, this has not yet been implemented.
388391

389392
See their [theming documentation](https://mermaid.js.org/config/theming.html) for more information.
390393

391394
### Creating a Diagram
395+
392396
In Docusaurus, we can use a [dyanmic Mermaid component](https://docusaurus.io/docs/next/markdown-features/diagrams#component) to define and load diagrams.
393397

394398
First, we import the dynamic component.
399+
395400
```
396401
import Mermaid from '@theme/Mermaid';
397402
```
398403

399404
Then, we instantiate the component with the graph passed in as an argument.
405+
400406
```
401407
<Mermaid
402408
value={`
@@ -410,9 +416,11 @@ Then, we instantiate the component with the graph passed in as an argument.
410416
```
411417

412418
### Configuring the Diagram
419+
413420
Diagrams can be modified indepent from the site-wide theme and configuration using [directives](https://mermaid.js.org/config/directives.html). Essentially, these directives are used to pass in an initialization configuration to the local diagram that overrides the existing global configuration.
414421

415422
For example, we can modify the way the arrow connecting two nodes is generated. Instead of the default, we can set the `curve` parameter to `step` to have the generated arrow move in steps rather than a smooth curve.
423+
416424
```
417425
<Mermaid
418426
value={`
@@ -434,10 +442,10 @@ For example, we can modify the way the arrow connecting two nodes is generated.
434442

435443
Notice that when defining a directive within the dynamic component, we must end every line with a backslash `\`. Make sure to not have any trailing commas, `,`, at the end of a list or dictionary.
436444

437-
See the [flowchart configuration](
438-
https://mermaid.js.org/config/schema-docs/config-defs-flowchart-diagram-config.html) to see all the settings specific to flowcharts that can be modified with directives.
445+
See the [flowchart configuration](https://mermaid.js.org/config/schema-docs/config-defs-flowchart-diagram-config.html) to see all the settings specific to flowcharts that can be modified with directives.
439446

440447
You may notice that there is no way to set the font size through the diagram's configuration. Instead that must be done by modifying the theme variables.
448+
441449
```
442450
<Mermaid
443451
value={`
@@ -459,10 +467,11 @@ You may notice that there is no way to set the font size through the diagram's c
459467
`}
460468
/>
461469
```
462-
See the (Mermaid configuration)[https://mermaid.js.org/config/schema-docs/config.html] documentation page for an exhaustive list of parameters.
463470

471+
See the (Mermaid configuration)[https://mermaid.js.org/config/schema-docs/config.html] documentation page for an exhaustive list of parameters.
464472

465473
Even though the font size has been modified, the rendered diagram's font may not appear to change size. Instead, the text size will remain a relatively similar size while the boxes and arrows appear smaller. Therefore, the sure-fire method to set a font size is to use HTML `<font size=10></font>` tags to wrap the text within a node.
474+
466475
```
467476
<Mermaid
468477
value={`

docs_outdoornav_user_manual/api/api_endpoints/autonomy_api.mdx

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ The OutdoorNav software publishes to the topics in this section either
1616
all the time or while an autonomous navigation missions is running. They
1717
can be used to monitor the behaviour of OutdoorNav.
1818

19-
2019
#### /assisted_teleop/cmd_vel
2120

2221
&emsp;&emsp;**Message Type:** geometry_msgs/Twist
@@ -88,14 +87,14 @@ including autonomy state and mode.
8887

8988
&emsp;&emsp;**Message Type:** [clearpath_dock_msgs/DockProperties](definitions.mdx#msg-dock-properties)
9089

91-
&emsp;&emsp;**Description:** A list of docks, in which each dock includes information related to
90+
&emsp;&emsp;**Description:** A list of docks, in which each dock includes information related to
9291
the location, id, etc...
9392

9493
#### /dock/state
9594

9695
&emsp;&emsp;**Message Type:** [clearpath_dock_msgs/DockState](definitions.mdx#msg-dock-state)
9796

98-
&emsp;&emsp;**Description:** The current state of the docking process.
97+
&emsp;&emsp;**Description:** The current state of the docking process.
9998

10099
#### /localization/odom
101100

@@ -169,7 +168,7 @@ the robot along the reference path.
169168
&emsp;&emsp;**Message Type:** [clearpath_navigation_msgs/Metrics](definitions.mdx#msg-metrics)
170169

171170
&emsp;&emsp;**Description:** This topic provides metric information regarding the lifetime of
172-
the navigation. This includes the total distance travelled, duration run, as well as mission
171+
the navigation. This includes the total distance travelled, duration run, as well as mission
173172
information such as how many missions have been sent, how many have been completed and the number
174173
of replanning maneuvers, recoveries and number of tasks executed.
175174

@@ -242,8 +241,8 @@ direction).
242241

243242
&emsp;&emsp;**Message Type:** [clearpath_logger_msgs/DeleteLog](definitions.mdx#srv-log-deletelog)
244243

245-
&emsp;&emsp;**Description:** Deletes a log as specified by the UUID provided. If the purge flag is set the log will be removed from
246-
the internal records entirely. If not, then the record will be marked as deleted and the meta data preserved, though log data will still
244+
&emsp;&emsp;**Description:** Deletes a log as specified by the UUID provided. If the purge flag is set the log will be removed from
245+
the internal records entirely. If not, then the record will be marked as deleted and the meta data preserved, though log data will still
247246
be deleted.
248247

249248
#### /onav_log/download_kmz
@@ -348,7 +347,7 @@ message for 1 second).
348347

349348
&emsp;&emsp;**Description:** Result topic from the undock action.
350349

351-
------------------------------------------------------------------------
350+
---
352351

353352
### Topics Subscribed to by Autonomy
354353

@@ -405,7 +404,7 @@ initialized by a previously sent goal.
405404
&emsp;&emsp;**Description:** This topic is used to send a goal to the undocking process.
406405
The goal is empty since we always consider undocking to be a local undocking process.
407406

408-
------------------------------------------------------------------------
407+
---
409408

410409
### Services Exported by Autonomy
411410

@@ -461,7 +460,7 @@ the location of an existing dock (where the `uuid` field is required).
461460

462461
&emsp;&emsp;**Service Type:** [clearpath_dock_msgs/srv/SetDockLocationByName](definitions.mdx#srv-set-dock-location-by-name)
463462

464-
&emsp;&emsp;**Description:** Can be used to update the location of an existing dock. Requires the semantic name
463+
&emsp;&emsp;**Description:** Can be used to update the location of an existing dock. Requires the semantic name
465464
of the dock to be input into the `name` field.
466465

467466
#### /localization/set_datum
@@ -497,9 +496,9 @@ should be used with caution.
497496
1. This feature does not take effect immediately when the service is
498497
called, but only takes effect at the next Goal.
499498

500-
2. Disabling collision avoidance also disables the continuous planner, in such a case where the
501-
continuous planner is enabled. When re-enabling the collision avoidance,
502-
the continuous planner must also be re-enabled using the following API service.
499+
2. Disabling collision avoidance also disables the continuous planner, in such a case where the
500+
continuous planner is enabled. When re-enabling the collision avoidance,
501+
the continuous planner must also be re-enabled using the following API service.
503502

504503
:::
505504

@@ -570,7 +569,7 @@ True, delay compensation is ENABLED and the controller will compensate
570569
for low-level mechanical delays. If False, delay compensation is
571570
DISABLED and the normal behaviour is expected.
572571

573-
------------------------------------------------------------------------
572+
---
574573

575574
### Actions Exported by Autonomy
576575

@@ -631,4 +630,4 @@ goal tolerances, goal heading, an optional start_waypoint_uuid, and a from_start
631630
&emsp;&emsp;**Action Type:** [clearpath_dock_msgs/action/Dock](definitions.mdx#action-undock)
632631

633632
&emsp;&emsp;**Description:** Undock the robot to the charging dock, if the docking
634-
package has been included.
633+
package has been included.

docs_outdoornav_user_manual/api/api_endpoints/definitions.mdx

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -841,26 +841,26 @@ bool[] camera_watchdog_triggered
841841

842842
#### Standard ROS Messages {#std-ros-msgs}
843843

844-
- [actionlib_msgs/GoalID](http://docs.ros.org/en/noetic/api/actionlib_msgs/html/msg/GoalID.html)
845-
- [diagnostic_msgs/DiagnosticArray](http://docs.ros.org/en/noetic/api/diagnostic_msgs/html/msg/DiagnosticArray.html)
846-
- [geometry_msgs/PolygonStamped](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/PolygonStamped.html)
847-
- [geometry_msgs/Polygon](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Polygon.html)
848-
- [geometry_msgs/PoseArray](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/PoseArray.html)
849-
- [geometry_msgs/Twist](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Twist.html)
850-
- [nav_msgs/OccupancyGrid](http://docs.ros.org/en/noetic/api/nav_msgs/html/msg/OccupancyGrid.html)
851-
- [nav_msgs/Odometry](http://docs.ros.org/en/noetic/api/nav_msgs/html/msg/Odometry.html)
852-
- [nav_msgs/Path](http://docs.ros.org/en/noetic/api/nav_msgs/html/msg/Path.html)
853-
- [sensor_msgs/Imu](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/Imu.html)
854-
- [sensor_msgs/LaserScan](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/LaserScan.html)
855-
- [sensor_msgs/NavSatFix](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/NavSatFix.html)
856-
- [sensor_msgs/PointCloud2](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/PointCloud2.html)
857-
- [std_msgs/Bool](http://docs.ros.org/en/noetic/api/std_msgs/html/msg/Bool.html)
858-
- [std_msgs/Empty](http://docs.ros.org/en/noetic/api/std_msgs/html/msg/Empty.html)
859-
- [std_msgs/String](http://docs.ros.org/en/noetic/api/std_msgs/html/msg/String.html)
860-
- [tf2_msgs/TFMessage](http://docs.ros.org/en/noetic/api/tf2_msgs/html/msg/TFMessage.html)
861-
- [wireless_msgs/Connection](http://docs.ros.org/en/noetic/api/wireless_msgs/html/msg/Connection.html)
862-
863-
------------------------------------------------------------------------
844+
- [actionlib_msgs/GoalID](http://docs.ros.org/en/noetic/api/actionlib_msgs/html/msg/GoalID.html)
845+
- [diagnostic_msgs/DiagnosticArray](http://docs.ros.org/en/noetic/api/diagnostic_msgs/html/msg/DiagnosticArray.html)
846+
- [geometry_msgs/PolygonStamped](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/PolygonStamped.html)
847+
- [geometry_msgs/Polygon](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Polygon.html)
848+
- [geometry_msgs/PoseArray](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/PoseArray.html)
849+
- [geometry_msgs/Twist](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Twist.html)
850+
- [nav_msgs/OccupancyGrid](http://docs.ros.org/en/noetic/api/nav_msgs/html/msg/OccupancyGrid.html)
851+
- [nav_msgs/Odometry](http://docs.ros.org/en/noetic/api/nav_msgs/html/msg/Odometry.html)
852+
- [nav_msgs/Path](http://docs.ros.org/en/noetic/api/nav_msgs/html/msg/Path.html)
853+
- [sensor_msgs/Imu](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/Imu.html)
854+
- [sensor_msgs/LaserScan](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/LaserScan.html)
855+
- [sensor_msgs/NavSatFix](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/NavSatFix.html)
856+
- [sensor_msgs/PointCloud2](http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/PointCloud2.html)
857+
- [std_msgs/Bool](http://docs.ros.org/en/noetic/api/std_msgs/html/msg/Bool.html)
858+
- [std_msgs/Empty](http://docs.ros.org/en/noetic/api/std_msgs/html/msg/Empty.html)
859+
- [std_msgs/String](http://docs.ros.org/en/noetic/api/std_msgs/html/msg/String.html)
860+
- [tf2_msgs/TFMessage](http://docs.ros.org/en/noetic/api/tf2_msgs/html/msg/TFMessage.html)
861+
- [wireless_msgs/Connection](http://docs.ros.org/en/noetic/api/wireless_msgs/html/msg/Connection.html)
862+
863+
---
864864

865865
### Service Definitions
866866

@@ -1192,6 +1192,7 @@ string[] tags
11921192
```
11931193

11941194
#### clearpath_mission_manager_msgs/srv/CloneMission.srv {#storage-clonemission}
1195+
11951196
```
11961197
# The UUID of the mission to clone
11971198
string uuid
@@ -2054,10 +2055,10 @@ string message
20542055

20552056
#### Standard ROS Services
20562057

2057-
- [std_srvs/Empty](http://docs.ros.org/en/noetic/api/std_srvs/html/srv/Empty.html)
2058-
- [std_srvs/SetBool](http://docs.ros.org/en/noetic/api/std_srvs/html/srv/SetBool.html)
2058+
- [std_srvs/Empty](http://docs.ros.org/en/noetic/api/std_srvs/html/srv/Empty.html)
2059+
- [std_srvs/SetBool](http://docs.ros.org/en/noetic/api/std_srvs/html/srv/SetBool.html)
20592060

2060-
------------------------------------------------------------------------
2061+
---
20612062

20622063
### Action Definitions
20632064

@@ -2170,7 +2171,6 @@ bool success
21702171
float32 percent_complete
21712172
```
21722173

2173-
21742174
#### clearpath_mission_scheduler_msgs/action/RunScheduleByUuid.action {#scheduler-runschedulebyuuid}
21752175

21762176
```
@@ -2337,4 +2337,4 @@ string message
23372337
# feedback
23382338
string message
23392339
clearpath_navigation_msgs/NetworkMissionSegment network_plan
2340-
```
2340+
```

0 commit comments

Comments
 (0)