Merge pull request #13 from sparkfun/updates-oct25

Minor docs updates

Author: santaimpersonator

.github/workflows/build_documentation.yml

@@ -40,7 +40,7 @@ jobs:
           python-version: 3.x
 
       - name: Install Python dependencies
-        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
+        run: pip install -r requirements.txt
 
       - name: Set up build cache
         run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

.github/workflows/update_documentation.yml

@@ -0,0 +1,65 @@
+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:
+          submodules: recursive
+          fetch-depth: 0
+          sparse-checkout: |
+            docs/modules.md
+            docs/carriers.md
+            docs/system_overview.md
+            docs/resources.md
+            flex_boards/
+            overrides/.icons/
+
+      - name: Update submodules
+        run: |
+          git submodule update --init --recursive
+          git submodule update --recursive --remote
+
+      - 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 -r requirements.txt
+
+      - 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/modules.md

@@ -91,7 +91,7 @@
 	</article>
 
 
-- **SparkPNT GNSS Flex Module - ZED-X20P & IM19 IMU**
+- **SparkPNT GNSS Flex Module - ZED-X20P**
 
 	---
 

docs/resources.md

@@ -33,10 +33,10 @@
 	- Component Documentation
 		- :fontawesome-solid-file-pdf: [Product Specifications](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/Quectel_LG290P03_GNSS_Module_Specification_V1.2.pdf)
 		- :fontawesome-solid-file-pdf: [Protocol Specification](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03lgx80p03_gnss_protocol_specification_v1-1.pdf)
-		- :fontawesome-solid-file-pdf: [RTK Application Note](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03lgx80p03_rtk_application_note_v1-1.pdf)
-		- :fontawesome-solid-file-pdf: [Base Station Mode Application Note](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03lgx80p_series_base_station_mode_application_note_v1-1.pdf)
 		- :fontawesome-solid-file-pdf: [Hardware Design](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03_hardware_design_v1-1.pdf)
 		- :fontawesome-solid-file-pdf: [Firmware Upgrade Guide](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03lgx80p03_firmware_upgrade_guide_v1-1.pdf)
+		- :fontawesome-solid-file-pdf: [Application Note - RTK Corrections](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03lgx80p03_rtk_application_note_v1-1.pdf)
+		- :fontawesome-solid-file-pdf: [Application Note - Base Station](SparkPNT_GNSS_Flex_Module_LG290P/assets/component_documentation/quectel_lg290p03lgx80p_series_base_station_mode_application_note_v1-1.pdf)
 	- :material-youtube: [Product Showcase](https://youtu.be/r-bhOLv4zsk)
 
 
@@ -49,9 +49,6 @@
 		- :fontawesome-solid-file-pdf: [Board Dimensions](SparkPNT_GNSS_Flex_Module_DAN-F10N/assets/board_files/dimensions.pdf)
 		- :material-folder-zip: [KiCad Files](SparkPNT_GNSS_Flex_Module_DAN-F10N/assets/board_files/kicad_files.zip)
 		- :material-cube-outline: [STEP File](SparkPNT_GNSS_Flex_Module_DAN-F10N/assets/3d_model/cad_model.step)
-	- :fontawesome-solid-computer: [u-center 2 Software](https://www.u-blox.com/en/product/u-center)
-		- :material-cloud-download: [Download](https://u-center2-updates.u-blox.com/u-center2-installer.exe)
-		- :material-book-open-variant: [User Manual](https://www.u-blox.com/en/info/u-center-2-user-guide)
 	- Component Documentation
 		- :fontawesome-solid-file-pdf: [Datasheet](https://content.u-blox.com/sites/default/files/documents/DAN-F10N_DataSheet_UBXDOC-963802114-13074.pdf)
 		- :fontawesome-solid-file-pdf: [Product Summary](https://content.u-blox.com/sites/default/files/documents/DAN-F10N_ProductSummary_UBXDOC-963802114-13162.pdf)
@@ -97,10 +94,10 @@
 		- LG290P GNSS Module
 			- :fontawesome-solid-file-pdf: [Product Specifications](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/Quectel_LG290P03_GNSS_Module_Specification_V1.2.pdf)
 			- :fontawesome-solid-file-pdf: [Protocol Specification](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03lgx80p03_gnss_protocol_specification_v1-1.pdf)
-			- :fontawesome-solid-file-pdf: [RTK Application Note](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03lgx80p03_rtk_application_note_v1-1.pdf)
-			- :fontawesome-solid-file-pdf: [Base Station Mode Application Note](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03lgx80p_series_base_station_mode_application_note_v1-1.pdf)
 			- :fontawesome-solid-file-pdf: [Hardware Design](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03_hardware_design_v1-1.pdf)
 			- :fontawesome-solid-file-pdf: [Firmware Upgrade Guide](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03lgx80p03_firmware_upgrade_guide_v1-1.pdf)
+			- :fontawesome-solid-file-pdf: [Application Note - RTK Corrections](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03lgx80p03_rtk_application_note_v1-1.pdf)
+			- :fontawesome-solid-file-pdf: [Application Note - Base Station](SparkPNT_GNSS_Flex_Module_LG290P-Tilt/assets/component_documentation/quectel_lg290p03lgx80p_series_base_station_mode_application_note_v1-1.pdf)
 		- IM19 Attitude Module
 			- :fontawesome-solid-file-pdf: [Datasheet](./assets/component_documentation/IM19.pdf)
 			- :fontawesome-solid-file-pdf: [Integration Guide](./assets/component_documentation/IM19EI_v1.4.1.pdf)

flex_boards/SparkPNT_GNSS_Flex_Module_DAN-F10N/docs/hardware_overview.md

@@ -157,11 +157,12 @@ The DAN-F10N GNSS module comes with a 20 x 20 x 8 mm, integrated, Right Hand Cir
 
 <div class="grid cards" markdown>
 
-<div markdown>
+<div style="text-align: center;" markdown>
 
-<article class="video-500px" style="text-align: center; margin: auto;" markdown>
-<iframe src="https://www.youtube.com/embed/7_Pxe2rVFIQ" title="u-blox F10 GNSS platform for meter-level accuracy in urban environments" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 ![QR code](./assets/img/qr_code/video-ublox_f10.png){ .qr width="85" }
+
+<article class="video-500px" style="margin: auto;" markdown>
+<iframe src="https://www.youtube.com/embed/7_Pxe2rVFIQ" title="u-blox F10 GNSS platform for meter-level accuracy in urban environments" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 </article>
 
 </div>
@@ -366,6 +367,7 @@ The GNSS Flex system is designed around two 2x10-pin, 2mm pitch headers used mat
 
 
 <div markdown>
+
 Below, are the features that are available from the DAN-F10N GNSS receiver.
 
 <article class="annotate" markdown>

flex_boards/SparkPNT_GNSS_Flex_Module_DAN-F10N/docs/software_overview.md

@@ -190,7 +190,7 @@ Before users can connect to the DAN-F10N GNSS Flex module, they will need to spe
 
 ## Arduino IDE
 !!! tip
-	For first-time users, who have never programmed before and are looking to use the Arduino IDE, we recommend beginning with the <a href="https://www.sparkfun.com/products/15631">SparkFun Inventor's Kit (SIK)</a>, which is designed to help users get started programming with the Arduino IDE.
+	For first-time users, who have never programmed before and are looking to use the Arduino IDE, we recommend beginning with the <a href="https://www.sparkfun.com/sparkfun-inventor-s-kit-for-arduino-uno-v4-1.html">SparkFun Inventor's Kit (SIK)</a>, which is designed to help users get started programming with the Arduino IDE.
 
 Most users may already be familiar with the Arduino IDE and its use. However, for those of you who have never heard the name *Arduino* before, feel free to check out the [Arduino website](https://www.arduino.cc/en/Guide/HomePage). To get started with using the Arduino IDE, check out our tutorials below:
 

flex_boards/SparkPNT_GNSS_Flex_Module_LG290P-Tilt/docs/assets/img/qr_code/video-quectel_lg290p.png renamed to flex_boards/SparkPNT_GNSS_Flex_Module_LG290P-Tilt/docs/assets/img/qr_code/video-lg290p.png

@@ -157,15 +157,15 @@ The LG290P GNSS Flex module has the following features:
 
 
 
-## LG290P GNSS Module
+## LG290P GNSS Receiver
 One of the centerpieces of the GNSS Flex module, is the [LG290P GNSS module](./assets/component_documentation/quectel_lg290p03_hardware_design_v1-1.pdf) from [Quectel](https://www.quectel.com/). The LG290P is a low-power, multi-band, multi-constellation GNSS receiver capable of delivering centimeter-level precision at high update rates. The built-in NIC anti-jamming unit provides professional-grade interference signal detection and elimination algorithms, which effectively mitigate against multiple narrow-band interference sources and significantly improves the signal reception performance in complex electromagnetic environments. With its performance advantages of high-precision and power consumption, this board is an ideal choice for high-precision navigation applications, such as intelligent robots, UAVs, precision agriculture, mining, surveying, and autonomous navigation.
 
 
 <div class="grid cards" markdown>
 
 <div style="text-align: center;" markdown>
 
-![QR code to product video](./assets/img/qr_code/video-quectel_lg290p.png){ .qr width="85px" }
+![QR code to product video](./assets/img/qr_code/video-lg290p.png){ .qr width="85px" }
 
 <article class="video-500px" style="margin: auto;" markdown>
 <iframe src="https://player.vimeo.com/video/1000742664?dnt=1&amp;app_id=122963" title="Quectel: Product Intro for LG290P GNSS Module" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
@@ -545,6 +545,7 @@ The GNSS Flex system is designed around two 2x10-pin, 2mm pitch headers used mat
 
 
 <div markdown>
+
 Below, are the features that are available from the LG290P GNSS receiver.
 
 <article class="annotate" markdown>
@@ -855,7 +856,7 @@ Below, are the features that are available from the IM19 attitude module.
 
 
 === "LED Output"
-	The `RTK` [PTH](https://en.wikipedia.org/wiki/Through-hole_technology "Plated Through Holes") pin operates as both the `RTK_LED` status indicator for the RTK positioning and `ANT_ON` power control for the external LNA or active antenna power.
+	The `RTK` pin operates as both the `RTK_LED` status indicator for the RTK positioning and `ANT_ON` power control for the external LNA or active antenna power.
 
 
 	<figure markdown>

flex_boards/SparkPNT_GNSS_Flex_Module_LG290P-Tilt/docs/hardware_overview.md

@@ -106,7 +106,7 @@ In the QGNSS software, users can click on the ++"Advance"++ button, at the botto
 
 
 ??? example "Example - `PQTMCFGUART` Message"
-	As an example, try utilizing the `PQTMCFGUART` PQTM message. Enter `$PQTMCFGUART,R*` into the **Data Input*** field of the QConsole. DOn't forget to select the `NMEA` and `CRLF` options from ++"Advance"++ settings menu. If entered and configured properly, the value `36` should pop up in the **Checksum** field of the QConsole; then, click on the <kbd>:material-send:</kbd> button to send the message.
+	As an example, try utilizing the `PQTMCFGUART` PQTM message. Enter `$PQTMCFGUART,R*` into the **Data Input** field of the QConsole. DOn't forget to select the `NMEA` and `CRLF` options from ++"Advance"++ settings menu. If entered and configured properly, the value `36` should pop up in the **Checksum** field of the QConsole; then, click on the <kbd>:material-send:</kbd> button to send the message.
 
 
 	``` bash