Docs build update

SFEMark · SFEMark · commit 70faa69b41ae · 2024-03-20T11:05:17.000-06:00
Adding page build files &amp; final review edits. Removing code snippets for examples to fix build errors but will re-add them once the repo is public.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -0,0 +1,40 @@
+name: Run mkdocs
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install Python dependencies
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 setuptools
+
+      # - name: Install Chrome
+      #   run: sudo apt install google-chrome-stable
+
+      # - run: pip uninstall -y beautifulsoup4
+      # - run: pip install beautifulsoup4==4.9.3
+
+      - name: Set up build cache
+        uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+
+      - name: Install Insiders build
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }} 
+        run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+      - run: mkdocs gh-deploy --force
diff --git a/docs/arduino_example.md b/docs/arduino_example.md
@@ -47,23 +47,12 @@ This does require some manual definition/setup for pins in the code which the ex
 
 This example uses the FastLED library to cycle the RGB LED on the Thing Plus through a rainbow. Open the code from your downloaded copy of the GitHub repository or copy the code below into a blank sketch. Make sure the FastLED Library is installed, select the board (ESP32S3 Dev Module) and the Port, and click the "Upload" button.  
 
-<!-- 
-??? "RGB LED Example"
-	```
-	--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/RGB_LED/RGB_LED.ino"
-	```
--->
+
 
 ## I<sup>2</sup>C Scanner Power Control
 
 This example shows how to toggle the peripheral power voltage supply on and off as well as scan for any I<sup>2</sup>C devices connected to the I<sup>2</sup>C bus/Qwiic connector. After uploading, open the [serial monitor](https://learn.sparkfun.com/tutorials/terminal-basics/arduino-serial-monitor-windows-mac-linux) with the baud set to **115200** and you should see a serial printout of the Fuel Gauge at 0x32 as well as any other devices connected to the Qwiic connector like the screenshot below shows. If you have a Qwiic board plugged in you should see the power LED on it blinking every second as the bus is powered on and off.
 
-<!-- 
-??? "I2C Scanner Power Control Example"
-	```
-	--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/I2C_Scanner_PowerControl/I2C_Scanner_PowerControl.ino"
-	```
--->
 
 <figure markdown>
 [![Serial printout of I2C scan.](./assets/img/I2C_Scanner_Output.jpg){ width="600"}](./assets/img/I2C_Scanner_Output.jpg "Click to enlarge")
@@ -75,20 +64,9 @@ The SD Card Detect example is a simple example that monitors the card detect pin
 
 After uploading, you can open the serial monitor with the baud set to **115200** and it should print out either "Card Inserted" or "No SD Card" depending on whether or not a &micro;SD card is present.
 
-<!-- 
-??? "SD Card Detect"
-	```
-	--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/SD_Card_Detect/SD_Card_Detect.ino"
-	```
--->
+
 
 ## PSRAM Test
 
 This example demonstrates how to enable and use PSRAM for RAM requests above a 1,000 byte threshold. The setup initializes PSRAM and prints out whether or not this was successful and then prints out available PSRAM space.
 
-<!-- 
-??? "PSRAM Test Example"
-	```
-	--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/main/Firmware/PSRAM_Test/PSRAM_Test.ino"
-	```
--->
diff --git a/docs/hardware_assembly.md b/docs/hardware_assembly.md
@@ -1,3 +1,7 @@
+---
+icon: material/cog
+---
+
 Now that we're familiar with the hardware on this Thing Plus board, it's time to connect it to our computer or battery power.
 
 ## Basic USB Assembly
diff --git a/docs/hardware_overview.md b/docs/hardware_overview.md
@@ -1,3 +1,7 @@
+---
+icon: material/cog
+---
+
 Let's take a closer look at the ESP32-S3 module and other hardware present on this Thing Plus board.
 
 ## ESP32-S3 Module
@@ -88,7 +92,7 @@ The board has three solder jumpers labeled <b>PWR</b>, <b>CHG</b>, and <b>LP_CTL
 [![Photo highlighting solder jumpers.](./assets/img/Thing_Plus_ESP32S3-Jumpers.jpg){ width="600"}](./assets/img/Thing_Plus_ESP32S3-Jumpers.jpg "Click to enlarge")
 </figure>
 
-The <b>LP_CTL</b> jumper controls how the Low Power and Peripherals power works. It is CLOSED by default to pull the power the RT9080 3.3V regulator's enable pin HIGH to enable peripheral power on the <b>3.3V_P</b> rail. 
+The <b>LP_CTL</b> jumper controls how the Low Power and Peripherals power works. It is CLOSED by default to pull the power the RT9080 3.3V regulator's enable pin HIGH to enable peripheral power on the <b>3.3V_P</b> rail. When opened, the regulator's enable pin connects directly to ESP32 IO45 for users to control manually. Refer to "Peripheral Power Control" above for more information.
 
 ## Board Dimensions
 
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -11,16 +11,16 @@ icon: material/book-open-page-variant
     ---
 
     <figure markdown>
-    ![Product Thumbnail]()
+    ![Product Thumbnail](https://cdn.sparkfun.com/r/600-600/assets/parts/2/4/7/6/6/WRL-24408-ESP-32-S3-Feature.jpg)
     </figure></a>
 
 
 
 -    The SparkFun Thing Plus - ESP32-S3 features the powerful and versatile ESP32-S3 from espressif<sup>&trade;</sup>. The ESP32-S3  It includes a LiPo battery charger and fuel gauge, &micro;SD card slot, an addressable LED and more. The Thing Plus footprint breaks out all of the ESP32-S3's 23 GPIO pins to 0.1"-spaced PTH headers. The board also has a USB-C connector for primary power and programming, 2-pin JST connector for a LiPo battery, and a Qwiic connector to integrate it into SparkFun's [Qwiic ecosystem](https://www.sparkfun.com/qwiic).
 
-    The ESP32 WROOM-S3 is built around an Xtensa<sup>&reg;</sup> 32-bit LX7 processor with massive processing power that operates at up to 240 MHz. It supports both 2.4 GHz WiFi and Bluetooth<sup>&reg;</sup> 5 (LE) with a built-in PCB antenna. This version of the ESP32-S3 has 4MB Flash memory and 2MB of dynamic/PSRAM and the board also has with a &micro;SD card slot for those who need more storage space.
+    The ESP32 WROOM-S3 is built around an Xtensa<sup>&reg;</sup> 32-bit LX7 processor with massive processing power that operates at up to 240 MHz. It supports both 2.4 GHz WiFi and Bluetooth<sup>&reg;</sup> 5 (LE) with a built-in PCB antenna. This version of the ESP32-S3 has 4MB Flash memory and 2MB of dynamic/PSRAM and the board also has a &micro;SD card slot for those who need more storage space.
 
-    The module has a host of peripherals that can be tied to nearly any GPIO pin including UART, I<sup>2</sup>C, SPI, LCD control, SDIO host, TWAI<sup>&reg;</sup> controller (compatible with ISO 11898-1, i.e., CAN Specification 2.), and more. The ESP32-S3 can run two USB ports simultaneously and can act as a USB host meaning you can connect USB peripherals like a keyboard or mouse to it in this configuration.
+    The module has a host of peripherals that can be tied to nearly any GPIO pin including UART, I<sup>2</sup>C, SPI, LCD control, SDIO host, TWAI<sup>&reg;</sup> controller (compatible with ISO 11898-1, i.e., CAN Specification 2.), and more. The ESP32-S3 can run two USB ports simultaneously and can act as a USB host.
 
     <center>
     [Purchase from SparkFun :fontawesome-solid-cart-plus:{ .heart }](https://www.sparkfun.com/products/24408){ .md-button .md-button--primary }
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -202,8 +202,8 @@ nav:
     - Hardware Assembly: hardware_assembly.md
     - Software Setup: 
       - Arduino Setup: software_setup.md
-      - Arduino Example: arduino_example.md
-  - Resources: resources_and_going_further.md
+      - Arduino Examples: arduino_example.md
+  - Resources: resources.md
   - Support:
     - Troubleshooting: troubleshooting.md
     - Submit Issues: github/file_issue.md
diff --git a/overrides/partials/nav.html b/overrides/partials/nav.html
@@ -67,11 +67,11 @@
       {{ item.render(nav_item, path, 1) }}
     {% endfor %}
 
-    <!-- Add Hard Copies to NAV menu -->
+    <!-- Add Print View to NAV menu -->
     <li class="md-nav__item">
       <a href="/SparkFun_Thing_Plus_ESP32-S3/print_view/" class="md-nav__link">
       <span class="md-ellipsis">
-          Hard Copies&nbsp;{% include ".icons/material/book-open-variant.svg" %}
+          Print View&nbsp;{% include ".icons/material/book-open-variant.svg" %}
       </span>
       </a>
     </li>
diff --git a/overrides/partials/tabs.html b/overrides/partials/tabs.html
@@ -35,7 +35,7 @@
     <ul class="md-tabs__list" style="float: right;">
       <li class="md-tabs__item">
         <a href="/SparkFun_Thing_Plus_ESP32-S3/print_view/" class="md-tabs__link">
-          Hard Copies 🖨️
+          Print View 🖨️
         </a>
       </li>
     </ul>
