Merge development to production

.gitattributes

@@ -0,0 +1,19 @@
+# Files determined by git to be text files
+# are automatically normalized to LF line endings.
+*       text=auto eol=lf
+# The following files are explicitly set to use LF line endings.
+*.mdx   eol=lf
+*.md    eol=lf
+*.json  eol=lf
+
+# If there are files which are generated with CRLF line endings,
+# it is recommended to set them to CRLF so that there is no unnecessary
+# diff when regenerating them.
+
+# The binary macro is equivalent to the following:
+# -text -diff
+# Which means that line endings are not normalized and no diff is generated.
+*.jpg   binary
+*.png   binary
+*.gif   binary
+*.mp4   binary

CODEOWNERS

@@ -1,2 +1,2 @@
-# Default all changes will request review from:
-* @rhysfaultless-cpr @jhiggins-cpr @tonybaltovski @hilary-luo
+# Default all changes will request review from:
+* @rhysfaultless-cpr @jhiggins-cpr @tonybaltovski @hilary-luo

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022-2023 Clearpath Robotics Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022-2023 Clearpath Robotics Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -63,12 +63,14 @@
       You can fix the errors by running Prettier on a single file, with `npx prettier --write <FILE PATH>`.
       For example, you can run the command `npx prettier --write README.md` to format this README.
 
+      If you have added a new folder and need to format all files within it you can use the `*` wildcard, for example" `npx prettier --write folder/*`
+
       - Refer to the _package.json_ to understand what this script calls.
       - Refer to the _.prettierrc.json_ to understand the rules Prettier is using when checking files.
 
       Note, we used to suggest the command `npm run format-write` to update all the files in this repository.
       We don't suggest this command anymore, since it is then difficult for reviewers of Pull Requests to find the intended content changes.
-      If you do continue to use this entire repositry command, you may see files that claim to be updated in Source Control, but don't have any visible changes.
+      If you do continue to use this entire repository command, you may see files that claim to be updated in Source Control, but don't have any visible changes.
       If so, you should run these commands in your terminal to prevent Git from noting these types of changes:
 
       git config --global core.filemode false
@@ -254,21 +256,20 @@ This helps Users know where they downloaded the file from later, as the asset is
     In an `img/` folder next to the markdown files where it will be used.
 
 6.  Files larger than 100 MB
-    
+
     Files added to GitHub must be smaller than 100 MB—_(at time of writing in 2025-04)_.
     You will be able to commit a large file locally, but the push to GitHub will fail.
     We are storing large files in an Amazon S3 Bucket, rather than the cpr-documentation repository's `/static/assets` directory.
     Note that this means large files will need to be added by Clearpath Robotics staff, as we do not provide public access to this S3 Bucket.
 
     To add a file:
 
-    * Sign into https://us-east-2.console.aws.amazon.com/s3/ .
-    * Navigate to the S3 Bucket `cpr-documentation-large-files `.
-    * Select the `Upload` button, and choose your local file.
-    * After the file has been uploaded, click on the new object, and copy its `Object URL`.
+    - Sign into https://us-east-2.console.aws.amazon.com/s3/ .
+    - Navigate to the S3 Bucket `cpr-documentation-large-files `.
+    - Select the `Upload` button, and choose your local file.
+    - After the file has been uploaded, click on the new object, and copy its `Object URL`.
       This is the public URL to access the file you uploaded.
       Note that this S3 Bucket is configured so all files' permissions are automatically set to public access.
-
 
 ## How to merge branches into the Production branch?
 

components/button_download.module.css

@@ -1,5 +1,5 @@
-.buttons {
-  display: flex;
-  align-items: center;
-  justify-content: center;
+.buttons {
+  display: flex;
+  align-items: center;
+  justify-content: center;
 }

components/button_download_step.tsx

@@ -1,12 +1,12 @@
-import styles from "./button_download.module.css";
-
-export default function ButtonStepDownload(props) {
-  return(
-    <div>
-      <div className={styles.buttons}>
-        <a className="button button--secondary button--lg" href={props.filePath}>Download STEP Model Of The Robot</a>
-      </div>
-      <br/>
-    </div>
-  )
-}
+import styles from "./button_download.module.css";
+
+export default function ButtonStepDownload(props) {
+  return(
+    <div>
+      <div className={styles.buttons}>
+        <a className="button button--secondary button--lg" href={props.filePath}>Download STEP Model Of The Robot</a>
+      </div>
+      <br/>
+    </div>
+  )
+}

components/button_download_wiring_diagram.tsx

@@ -1,12 +1,12 @@
-import styles from "./button_download.module.css";
-
-export default function ButtonDownload(props) {
-  return(
-    <div>
-      <div className={styles.buttons}>
-        <a className="button button--secondary button--lg" href={props.filePath} target="_blank">Download The Robot's Wiring Diagram</a>
-      </div>
-      <br/>
-    </div>
-  )
-}
+import styles from "./button_download.module.css";
+
+export default function ButtonDownload(props) {
+  return(
+    <div>
+      <div className={styles.buttons}>
+        <a className="button button--secondary button--lg" href={props.filePath} target="_blank">Download The Robot's Wiring Diagram</a>
+      </div>
+      <br/>
+    </div>
+  )
+}

components/common_lighting_states_estop_reset_operational.mdx

@@ -1,9 +1,9 @@
-<div class="table-container-for-centering">
-  <div class="centred-table">
-    | Lighting State                       | Lighting Pattern                                                                         |
-    | :----------------------------------- | :--------------------------------------------------------------------------------------: |
-    | Emergency Stop                       | <img src="/img/robot_images/common_images/lighting_images/stopped.gif" width="100"/>     |
-    | Needs Reset _(after Emergency Stop)_ | <img src="/img/robot_images/common_images/lighting_images/needs_reset.gif" width="100"/> |
-    | Operational _(Driving or Idle)_      | <img src="/img/robot_images/common_images/lighting_images/driving.png" width="100"/>     |
-  </div>
-</div>
+<div class="table-container-for-centering">
+  <div class="centred-table">
+    | Lighting State                       | Lighting Pattern                                                                         |
+    | :----------------------------------- | :--------------------------------------------------------------------------------------: |
+    | Emergency Stop                       | <img src="/img/robot_images/common_images/lighting_images/stopped.gif" width="100"/>     |
+    | Needs Reset _(after Emergency Stop)_ | <img src="/img/robot_images/common_images/lighting_images/needs_reset.gif" width="100"/> |
+    | Operational _(Driving or Idle)_      | <img src="/img/robot_images/common_images/lighting_images/driving.png" width="100"/>     |
+  </div>
+</div>

components/common_risk_assessment_for_integrations.mdx

@@ -1,9 +1,9 @@
-:::safety-danger
-
-**Always perform a risk assessment prior to any custom integrations.**
-
-Custom integrations are outside the scope of the robot's safety assessment, as custom integrations may result in new hazards.
-
-:::
-
-<br />
+:::safety-danger
+
+**Always perform a risk assessment prior to any custom integrations.**
+
+Custom integrations are outside the scope of the robot's safety assessment, as custom integrations may result in new hazards.
+
+:::
+
+<br />

components/common_who_can_maintain_the_robot.mdx

@@ -1,13 +1,13 @@
-:::safety-danger
-
-Maintaining robots can be dangerous.
-There are hazards from high energy batteries, sharp edges, joints that can shear, and heavy items that can crush.
-The robot is intended to be maintained by a technician that is familiar with safe work procedures, and has experience using the required tools.
-
-Technicians must read and understand this manual.
-
-Technicians must review and understand their worksite's Risk Assessment and required procedures.
-
-Contact our [Support Team](#support) if you have any questions.
-
-:::
+:::safety-danger
+
+Maintaining robots can be dangerous.
+There are hazards from high energy batteries, sharp edges, joints that can shear, and heavy items that can crush.
+The robot is intended to be maintained by a technician that is familiar with safe work procedures, and has experience using the required tools.
+
+Technicians must read and understand this manual.
+
+Technicians must review and understand their worksite's Risk Assessment and required procedures.
+
+Contact our [Support Team](#support) if you have any questions.
+
+:::

components/common_wireless_emergency_stop_charging.mdx

@@ -1,41 +1,41 @@
-### Charging The Wireless Emergency Stop Transmitter
-
-This transmitter is part of the _Wireless Emergency Stop_ upgrade kit for Husky.
-
-1.  Remove the battery from the _Wireless Emergency Stop Transmitter_.
-2.  Connect the charger's AC cable to an outlet at your worksite.
-3.  Connect the transmitter's battery to the charger.
-
-<center>
-  <figure>
-    <img
-      src="/img/robot_images/common_images/wireless_emergency_stop_charger_empty.png"
-      width="350"
-    />
-    <img
-      src="/img/robot_images/common_images/wireless_emergency_stop_charger_charging.png"
-      width="350"
-    />
-    <figcaption>Wirelesss Emergency Stop Transmitter's Charger</figcaption>
-  </figure>
-</center>
-
-<center>
-  <figure>
-    <img
-      src="/img/robot_images/common_images/wireless_emergency_stop_transmitter_battery_removal_1.png"
-      width="350"
-    />
-    <img
-      src="/img/robot_images/common_images/wireless_emergency_stop_transmitter_battery_removal_2.png"
-      width="350"
-    />
-    <figcaption>Removing the Wirelesss Emergency Stop Transmitter's Battery</figcaption>
-  </figure>
-</center>
-
-:::info
-
-The robot's spare parts kit included a second battery for the transmitter.
-
-:::
+### Charging The Wireless Emergency Stop Transmitter
+
+This transmitter is part of the _Wireless Emergency Stop_ upgrade kit for Husky.
+
+1.  Remove the battery from the _Wireless Emergency Stop Transmitter_.
+2.  Connect the charger's AC cable to an outlet at your worksite.
+3.  Connect the transmitter's battery to the charger.
+
+<center>
+  <figure>
+    <img
+      src="/img/robot_images/common_images/wireless_emergency_stop_charger_empty.png"
+      width="350"
+    />
+    <img
+      src="/img/robot_images/common_images/wireless_emergency_stop_charger_charging.png"
+      width="350"
+    />
+    <figcaption>Wirelesss Emergency Stop Transmitter's Charger</figcaption>
+  </figure>
+</center>
+
+<center>
+  <figure>
+    <img
+      src="/img/robot_images/common_images/wireless_emergency_stop_transmitter_battery_removal_1.png"
+      width="350"
+    />
+    <img
+      src="/img/robot_images/common_images/wireless_emergency_stop_transmitter_battery_removal_2.png"
+      width="350"
+    />
+    <figcaption>Removing the Wirelesss Emergency Stop Transmitter's Battery</figcaption>
+  </figure>
+</center>
+
+:::info
+
+The robot's spare parts kit included a second battery for the transmitter.
+
+:::