Merge pull request #488 from clearpathrobotics/development

Production sync

Author: tonybaltovski

README.md

@@ -50,9 +50,9 @@
 
         git clone https://github.com/clearpathrobotics/cpr-documentation.git
 
-2.  Create a branch from development. with a name indicating the purpose, such as _feature_xxxxxx_
+2.  Create a branch from development with a name indicating the purpose, such as _feature_xxxxxx_
 3.  Make changes to the relevant files.
-4.  Test using your local server, using the steps mentioned [Steps to run this on your computer locally](##-steps-to-run-this-on-your-computer-locally)
+4.  Test using your local server, using the steps mentioned [Steps to run this on your computer locally](#steps-to-run-this-on-your-computer-locally)
 5.  When ready, enter `ctrl-c` in your terminal to stop the server. Then run `npm run build` to test that the site builds corretly.
 6.  Resolve any errors that the terminal reports, and rerun the command `npm run build`.
 7.  Finally, check that your updates adhere to our code formatting standard, by running the command `npm run format-check`.
@@ -129,18 +129,18 @@ When it is time to publish a numbered release of the user manual:
 
 <br>
 Follow the steps for the OutdoorNav User Manual workflow above, replacing
-**outdoornav** with **indoornav**.
+<b>outdoornav</b> with <b>indoornav</b>.
 
 </details>
 
-## Workflow for publishing Robots / ROS User Manual updates
+## Workflow for publishing Software User Manual updates
 
 <details>
 
-<summary>Click to expand for details on how to update the Robots / ROS User Manual</summary>
+<summary>Click to expand for details on how to update the Software User Manual</summary>
 
 <br>
-The Robots / ROS sections of the website are a "versioned" document called `docs`, which means that a snapshot of the content is
+The Software sections of the website are a "versioned" document called <code>docs</code>, which means that a snapshot of the content is
 made to align with each ROS version. This allows users to access version-specific copies of the
 documentation.
 
@@ -217,7 +217,7 @@ includeCurrentVersion: false,
     HTML commenting—`<!-- -->`—causes issues with the MDX extension in VS Code.
 2.  Refer to [Docusaurus's guide](https://docusaurus.io/docs/next/markdown-features) for supported Markdown features.
 3.  For advanced users, refer to [Markdown MDX](https://mdxjs.com/) for adding React Components to a Markdown file.
-4.  for advanced users, you may create React pages using _.js_ or _.ts_ file types.
+4.  For advanced users, you may create React pages using _.js_ or _.ts_ file types.
 
 ## How should I name files?
 
@@ -513,3 +513,33 @@ Even though the font size has been modified, the rendered diagram's font may not
   `}
 />
 ```
+
+## Spelling Guide
+
+Spelling on within this repository should align with the Government of Canada's [TERMIUM Plus®](https://www.btb.termiumplus.gc.ca/).
+Industry terms should align with the related organization's preferred spelling.
+
+<details>
+  <summary>Click to expand spelling examples</summary>
+  <table>
+    <tr><th>Correct spelling</th><th>Mistake</th></tr>
+    <tr><th>10</th><th>Ten</th></tr>
+    <tr><th>2X</th><th>2x</th></tr>
+    <tr><th>Aluminum</th><th>Aluminium</th></tr>
+    <tr><th>Antennas</th><th>Antennae</th></tr>
+    <tr><th>Antennas</th><th>Aerial</th></tr>
+    <tr><th>AWS, or Amazon Web Services</th><th>Amazon AWS</th></tr>
+    <tr><th>Colour</th><th>Color</th></tr>
+    <tr><th>Computer</th><th>PC</th></tr>
+    <tr><th>Enable Switch</th><th>Deadman Switch</th></tr>
+    <tr><th>Emergency Stop</th><th>E-stop</th></tr>
+    <tr><th>GitHub</th><th>Github</th></tr>
+    <tr><th>Lidar</th><th>LiDAR</th></tr>
+    <tr><th>Metre</th><th>Meter</th></tr>
+    <tr><th>ROS 2</th><th>ROS2</th></tr>
+    <tr><th>RViz</th><th>Rviz</th></tr>
+    <tr><th>Gmapping</th><th>gmapping</th></tr>
+    <tr><th>Tire</th><th>Tyre</th></tr>
+    <tr><th>Wi-Fi</th><th>wifi</th></tr>
+  </table>
+</details>

components/common_wireless_joystick_ps4.mdx

@@ -11,7 +11,7 @@ To connect the joystick to your robot:
 3.  Press the _PS_ button in the centre of the joystick.
 4.  The joystick's top LED should start pulsing white or blue.
     This means the joystick is attempting to connect.
-5.  The joysick's top LED should eventually become solid blue, indicating that it has connected to the robot's computer.
+5.  The joystick's top LED should eventually become solid blue, indicating that it has connected to the robot's computer.
 
 
 <center>

components/husky_a200/husky_a200_step_model.mdx

@@ -3,7 +3,7 @@ import ComponentButtonStepDownload from "/components/button_download_step.tsx";
 ### STEP Model {#step-model}
 
 <div>
-  <ComponentButtonStepDownload filePath={"https://cpr-documentation-large-files.s3.us-east-2.amazonaws.com/034991-GEO_1.STEP"}/>
+  <ComponentButtonStepDownload filePath={"https://cpr-documentation-large-files.s3.us-east-2.amazonaws.com/034991-GEO_2.STEP"}/>
 
 This simplified 3D model of the Husky A200 includes details like the internal
   battery, circuit board where you can connect to the robot's electrical 

components/husky_a300/husky_a300_amp_arch_cables.mdx

@@ -4,7 +4,7 @@ The _Sensor Arch_ places Husky's cameras and GNSS antennas above the robot for o
 These steps will give you access to the related cable routings for repairs:
 
 1.  Remove the 3 screws from the inside access panel.
-2.  Remove the panel by sliding is toward the end of the robot.
+2.  Remove the panel by sliding it toward the end of the robot.
 3.  The _Arch Posts_ have cable tie anchors.
     You can remove the cable ties with side cutters.
 4.  Cables route through an obround cutout in the _Enclosure_.

components/husky_a300/husky_a300_amp_check_sensors.mdx

@@ -3,7 +3,7 @@
 Husky AMP includes several sensors that are used for robot navigation. After connecting
 to Husky AMP's network, confirm that each sensor is functional by using the steps below.
 
-1. Connect to your laptop to the robot using SSH. To do so, execute the following in a terminal window:
+1. Connect your laptop to the robot using SSH. To do so, execute the following in a terminal window:
    ```
    ssh robot@192.168.131.1
    ```

components/husky_a300/husky_a300_amp_connector_bulkhead.mdx

@@ -11,7 +11,7 @@
 </center>
 
 To make a Husky AMP, we take a Husky A300, remove the Top Plate, and then install an enclosure on top of the base robot.
-We added a connector bulkhead between the base robot and the enclosure to keep cable routings tidy, and make the maintenence process quick.
+We added a connector bulkhead between the base robot and the enclosure to keep cable routings tidy, and make the maintenance process quick.
 The connectors on this bulkhead are extension cables from existing [Husky A300 interfaces](/docs_robots/outdoor_robots/husky/a300/integration_husky/#system-interface-circuit-board-connector-summary), which are listed below.
 
 <center>

components/husky_a300/husky_a300_components_observer.mdx

@@ -32,6 +32,6 @@ Refer to the [Husky A300 AMP's Components Overview](/docs_robots/solutions/husky
       src="/img/robot_images/husky_a300_images/husky_a300_observer_isometric_3.png"
       width="800"
     />
-    <figcaption>The Husky Oberver, with the included Stationary Dock.</figcaption>
+    <figcaption>The Husky Observer, with the included Stationary Dock.</figcaption>
   </figure>
 </center>

components/husky_a300/husky_a300_computer.mdx

@@ -30,7 +30,7 @@ Clearpath offers a standard computer with an Intel i3 processor, or a performanc
       4.  Wi-Fi antennas.
       5.  Power cable.
       6.  Optional graphics card's PCIe riser cable.
-  4.  Remove the 4 screws fastning the computer to Husky's _Electronics Tray_.
+  4.  Remove the 4 screws fastening the computer to Husky's _Electronics Tray_.
   5.  Remove the computer from the robot.
 
   :::note

components/husky_a300/husky_a300_electronics_tray.mdx

@@ -19,7 +19,7 @@ This tray includes the:
 * Optional secondary computer or graphics card, _(not shown in the image)_
 * Optional USB hub, _(not shown in the image)_
 
-You may want to access remove the _Electonics Tray_ to access the integration bay under the tray,
+You may want to remove the _Electronics Tray_ to access the integration bay under the tray,
   or to maintain Husky's _Batteries_ and _Power Distribution_ components. 
 
 #### Hinging The Electronics Tray

components/husky_a300/husky_a300_emergency_stop_buttons.mdx

@@ -33,7 +33,7 @@ The 2 relays are connected in series, so if one welds closed due to a failure, t
 The relays's physical states are monitored with Husky's Common Core microcontroller, and should flag a maintenance issue if either relay is damaged. 
 
 <Admonition type="danger" title=" ">
-  Husky's microcontroller is does not meet any performance level per ISO 13849-1.
+  Husky's microcontroller does not meet any performance level per ISO 13849-1.
   Husky's microcontroller can be replaced with a PLC to achieve a known performance level for fault monitoring.
   [Contact our Support Team](#support) if you have questions about this.
 </Admonition>