Documentation Initial Review

Initial review changes for docs. Adding workflows files to publish site.

Author: SFEMark

.github/workflows/build_documentation.yml

@@ -0,0 +1,52 @@
+name: Build Documentation
+
+# Allows you to run this workflow manually from the Actions tab
+# on:
+#   workflow_dispatch:
+#     branches: ["main"]
+
+# Allows this workflow to run automatically on pushes/commits
+on:
+  push:
+    branches: ["main"]
+
+# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
+permissions:
+  contents: write
+
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install pgnquant for optimize plugin
+        run: sudo apt-get install pngquant
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install Python dependencies
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
+
+      - name: Set up build cache
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install Insiders build
+        env:
+          MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
+        run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+      - run: mkdocs gh-deploy --force

docs/assets/img/arduino_boards.jpg

@@ -1,15 +1,15 @@
 # Contribute: Make an Augmentation!
-Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a>
+Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Iot_RedBoard_RP2350/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_IoT_RedBoard_RP2350.svg" /></a>
 
 ## :material-file-document-multiple:&nbsp;Improve our Documentation
 All of this documentation can be modified by you! Please help us make it better.
 
-* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
+* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/tree/main/docs) of the [SparkFun IoT RedBoard repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350).
 
 <!-- ### :material-source-pull:&nbsp;Submit a Correction -->
 ### Submit a Correction
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/fork).
 2. Add your corrections or improvements to the markdown file.
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	* Once received, the documentation specialist will automatically be notified.
@@ -18,12 +18,12 @@ All of this documentation can be modified by you! Please help us make it better.
 ## :material-cog:&nbsp;Improve our Hardware Design
 All of our designs are open-source! Please help us make it better.
 
-* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
+* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350).
 
 <!-- ### :material-source-pull:&nbsp;Submit a Design Enhancement -->
 ### Submit a Design Enhancement
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/fork).
 2. Add your design augmentation(s)
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	1. Once received, the engineer in charge of the original design will automatically be notified.
@@ -36,6 +36,6 @@ All of our designs are open-source! Please help us make it better.
 ## Contributors&nbsp;:clap:
 Let's provide some recognition to the contributors for this project!
 
-![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_Pro_Micro_RP2350)
+![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_IoT_RedBoard_RP2350)
 <br>
-<a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a>
+<a href="https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_IoT_RedBoard_RP2350.svg" /></a>

docs/github/contribute.md

@@ -1,6 +1,6 @@
 # Did we make a mistake?
 
-Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a>
+Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_IoT_RedBoard_RP2350.svg" /></a>
 
 <!-- Technical Assistance Box -->
 !!! warning "Need Help?"
@@ -20,15 +20,15 @@ Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/S
 
 All of our documentation can be modified by you! Please help us make it better.
 
-* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
+* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350).
 
 ### 🔍 Spot something wrong?
 
-If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and let us know.
+If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/issues) and let us know.
 
 ### Do you have a suggested correction?
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/fork).
 2. Add your correction(s) or improvement(s) to the markdown file(s)
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	* Once received, the documentation specialist will automatically be notified.
@@ -38,15 +38,15 @@ If a section of the documentation is incorrect, please [open an issue](https://g
 
 All of our designs are open-source! Please help us make it better.
 
-* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350).
+* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350).
 
 ### Does something not make sense? 🤔
 
-If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and let us know.
+If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/issues) and let us know.
 
 ### Did we forget to include an important function of the board? 🤦
 
-If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and file a feature request.
+If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/issues) and file a feature request.
 
 !!! tip "Design Considerations"
 	Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements.
@@ -56,7 +56,7 @@ If part of the board's functionality is missing, please [open an issue](https://
 
 ### Do you wish to contribute directly to improving the board design?
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_IoT_RedBoard_RP2350/fork).
 2. Add your design augmentation(s)
 3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
 	1. Once received, the engineer in charge of the original design will automatically be notified.

docs/github/file_issue.md

@@ -8,10 +8,6 @@ MicroPython is an application of the Python 3 language that runs on microcontrol
 
 ## UF2 Firmware
 
-The SparkFun IoT RedBoard - RP2350 is available in the main release of MicroPython [here](https://micropython.org/download/). Search for "SparkFun IoT RedBoard - RP2350" on the MicroPython downloads page for the correct firmware. This release does **not** include PSRAM support.  of MicroPython to include UF2 files for the IoT RedBoard - RP2350 so to get users started before then, we have Beta releases of MicroPython firmware available [here](https://github.com/sparkfun/micropython/releases) or by clicking the button below:
-
-<center>
-    [SparkFun MicroPython Beta Releases](https://github.com/sparkfun/micropython/releases){ .md-button .md-button--primary}
-</center>
+The SparkFun IoT RedBoard - RP2350 ships with MicroPython firmware pre-loaded so you do not need to download and install it in your board. If you need to update the firmware at any point, it is available in the main release of MicroPython [here](https://micropython.org/download/). Search for "SparkFun IoT RedBoard - RP2350" on the MicroPython downloads page for the correct firmware. This release does **not** include PSRAM support; if your project requires using PSRAM, you can find a Beta release MicroPython firmware available [here](https://github.com/sparkfun/micropython/releases).
 
 Download the latest release and then put the IoT RedBoard - RP2350 into UF2 bootloader mode and open the location the board appeared as a USB storage device (it should appear as "RP2350"). Next, drag and drop the UF2 file into the RP2350 folder and the board should reboot. After the board reboots, open up your preferred MicroPython IDE (or command line interface) and you can start interacting with your RedBoard IoT. Head over to the Quick Start guide for an example project that shows how to connect the board to a WiFi network, download data from a website and control the RGB LED.

docs/micropython.md

@@ -154,7 +154,7 @@ plugins:
       type: timeago
   # Add git committers at the bottom of the page
   - git-committers:
-      repository: sparkfun/SparkFun_Pro_Micro_RP2350
+      repository: sparkfun/SparkFun_IoT_RedBoard_RP2350
       branch: main
   # Add git authors at the bottom of the page
   - git-authors