Merge pull request #560 from clearpathrobotics/development

Merge to Production

Author: tonybaltovski

.cspell/clearpath-dictionary.txt

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/dependabot.yml

@@ -14,16 +14,18 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.13.0]
+        node-version: [22.22.0]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v6
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v6
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
     - run: npm ci
+    - name: Spell Check
+      run: npm run spellcheck
     - run: npm run build --if-present
     # - run: npm test

.github/workflows/node.js.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: configure AWS credentials
         id: creds
-        uses: aws-actions/configure-aws-credentials@v4
+        uses: aws-actions/configure-aws-credentials@v6
         with:
           aws-region: us-east-2
           role-to-assume: ${{ secrets.AWS_GITHUB_ACTIONS_ROLE }}

.github/workflows/preview-close.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - name: configure AWS credentials
         id: creds
-        uses: aws-actions/configure-aws-credentials@v4
+        uses: aws-actions/configure-aws-credentials@v6
         with:
           aws-region: us-east-2
           role-to-assume: ${{ secrets.AWS_GITHUB_ACTIONS_ROLE }}
@@ -47,7 +47,7 @@ jobs:
         if: github.event_name == 'delete'
       - name: configure AWS credentials
         id: creds
-        uses: aws-actions/configure-aws-credentials@v4
+        uses: aws-actions/configure-aws-credentials@v6
         with:
           aws-region: us-east-2
           role-to-assume: ${{ secrets.AWS_GITHUB_ACTIONS_ROLE }}

.github/workflows/preview-rc.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - name: configure AWS credentials
         id: creds
-        uses: aws-actions/configure-aws-credentials@v4
+        uses: aws-actions/configure-aws-credentials@v6
         with:
           aws-region: us-east-2
           role-to-assume: ${{ secrets.AWS_GITHUB_ACTIONS_ROLE }}

.github/workflows/preview.yaml

@@ -30,7 +30,7 @@
 3.  Open the folder
 4.  In a terminal, navigate to the root of the project folder and run `npm install`
 5.  Start the local server by running `npm run start`
-6.  A new tab should open in your prefered web browser once the site is running.
+6.  A new tab should open in your preferred web browser once the site is running.
     Your terminal session should show the port the webpage is running on.
     The default address is http://localhost:3000/ but this may change if you are already using that port for another site.
 7.  If you want to test something on a mobile screensize; you can do this within your desktop's Chrome browser.
@@ -53,7 +53,7 @@
 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)
-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.
+5.  When ready, enter `ctrl-c` in your terminal to stop the server. Then run `npm run build` to test that the site builds correctly.
 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`.
     The terminal will either report:
@@ -76,14 +76,18 @@
       git config --global core.filemode false
       git config --global core.autocrlf false
 
-8.  When ready, publish your branch on GitHub, and submit a Pull Request to merge your changes into the _development_ branch.
+8.  Run the spell checker to catch any spelling errors by running `npm run spellcheck`.
+    If there are spelling errors, correct them in the source files. If you encounter a valid word that is flagged
+    (such as a technical term, brand name, or Canadian English spelling), add it to `.cspell/clearpath-dictionary.txt`.
+
+9.  When ready, publish your branch on GitHub, and submit a Pull Request to merge your changes into the _development_ branch.
     Pull Requests to the _production_ branch will not merged.
     Also note that this GitHub repository has branch protection rules, that prevent you from committing directly to _production_ and _development_.
     The Pull Request will automatically request reviews from people listed in the codeowners file, but you can also add more reviewers.
 
     <img src="/static/img/readme_images/readme_github_1.png" width="467"/>
 
-9.  The administrators of this documentation will review the website for any functional issues,
+10. The administrators of this documentation will review the website for any functional issues,
     and will periodically merge the latest commits in the _development_ branch into the _production_ branch.
 
 ## Workflow for publishing OutdoorNav User Manual updates

README.md

@@ -5,7 +5,7 @@ Clearpath Robotics recommends the following procedures be followed to reduce the
 - Assert a stop using the remote stop device (if present) before approaching the robot.
 - Never place the remote stop device (if present) on or inside the robot.
 - Always be vigilant around the robot, even when a stop is asserted.
-- Perform no maintenance or troubleshooting on the robot without training and familiarisation.
+- Perform no maintenance or troubleshooting on the robot without training and familiarization.
 - Follow electrical safety best practices when working with electrical systems and components.
 - Disconnect battery using main disconnect of the robot before working inside robot.
 - Wear personal protective equipment including high-visibility clothing, head and eye protection while

components/common_safe_work_procedures.mdx

@@ -16,7 +16,7 @@ This transmitter is part of the _Wireless Emergency Stop_ upgrade kit for Husky.
       src="/img/robot_images/common_images/wireless_emergency_stop_charger_charging.png"
       width="350"
     />
-    <figcaption>Wirelesss Emergency Stop Transmitter's Charger</figcaption>
+    <figcaption>Wireless Emergency Stop Transmitter's Charger</figcaption>
   </figure>
 </center>
 
@@ -30,7 +30,7 @@ This transmitter is part of the _Wireless Emergency Stop_ upgrade kit for Husky.
       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>
+    <figcaption>Removing the Wireless Emergency Stop Transmitter's Battery</figcaption>
   </figure>
 </center>
 

components/common_wireless_emergency_stop_charging.mdx

@@ -5,7 +5,7 @@ import Admonition from "@theme/Admonition";
 [//]: <> (TODO, add an image of the enclosure being removed.)
 
 <details>
-  <summary>To remove the large electonics enclosure:</summary>
+  <summary>To remove the large electronics enclosure:</summary>
 
   1.  Turn off the Husky.
   2.  Open the _Rear Charge Port Door_.