Merge branch 'main' of https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331

Author: SFEMark

.github/README.md

@@ -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
+
+      # - 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

.github/workflows/mkdocs.yml

@@ -1,41 +1,37 @@
-SparkFun <PRODUCT NAME>
+SparkFun Spectral UV Sensor - AS7331 (Qwiic) 
 ========================================
 
-[![SparkFun Part Name](URL for picture of part)](URL for product on Sparkfun.com)
+<table class="table table-hover table-striped table-bordered">
+    <tr align="center">
+        <td><a href="https://www.sparkfun.com/products/23517"><img src="https://cdn.sparkfun.com/r/600-600/assets/parts/2/3/8/0/8/23517-Spectral-UV-Sensor_Feature.jpg" alt="Standard"></a></td>
+        <td><a href="https://www.sparkfun.com/products/23518"><img src="https://cdn.sparkfun.com/r/600-600/assets/parts/2/3/8/0/9/23518-Spectral-UV-Sensor-Mini_Feature.jpg" alt="Mini"></a></td>
+    </tr>
+    <tr align="center">
+        <td><a href="https://www.sparkfun.com/products/23517">SparkFun Spectral UV Sensor - AS7331 (Qwiic)</a></td>
+        <td><a href="https://www.sparkfun.com/products/23518">SparkFun Mini Spectral UV Sensor - AS7331 (Qwiic)</a></td>
+    </tr>
+</table>
 
-[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com)
-
-<Basic description of the part.>
+The SparkFun Spectral UV Sensor - AS7331 (Qwiic) features the AS7331 UV sensor from ams OSRAM<sup>&copy;</sup> and measures UV radiation on three channels: UVA (320-400nm), UVB (280-320nm), and UVC (200-280nm) with high sensitivity and accuracy. The three channels on the AS7331 each have individual photodiodes with built-in interference filters. The sensor has three operating modes: Single Measurement (CMD), Continuous Measurement (CONT), and Synchronized Measurement (SYNx) with an automatic power down sequence between measurements for low current consumption in all three modes. 
 
 Repository Contents
 -------------------
 
 * **/Documentation** - Data sheets, additional product information
-* **/Enclosure** - Enclosure files 
-* **/Firmware** - Example code 
 * **/Hardware** - Eagle design files (.brd, .sch)
-* **/Libraries** - Libraries for use with the <PRODUCT NAME>
 * **/Production** - Production panel files (.brd)
-* **/Software** - Related software for the <PRODUCT NAME>
+* **/docs** -  Documentation files for the Spectral UV Sensor
+* **/overrides** -  Overrides for GitHub pages content
 
 Documentation
 --------------
-* **[Library](GitHub library URL)** - <LANGUAGE> library for the <PRODUCT NAME>.
-* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>.
-* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products.
-* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products. 
-* **[SparkFun Graphical Datasheets](https://github.com/sparkfun/Graphical_Datasheets)** -Graphical Datasheets for various SparkFun products.
+* **[Library](https://github.com/sparkfun/SparkFun_AS7331_Arduino_Library)** - Arduino library for the Spectral UV Sensor - AS7331 (Qwiic).
+* **[Hookup Guide](https://sparkfun.github.io/SparkFun_Spectral_UV_Sensor_AS7331)** - Basic hookup guide for the Spectral UV Sensor - AS7331 (Qwiic).
 
 Product Versions
 ----------------
-* [Part SKU](part URL) - Basic part and short description here
-* [Retail part SKU](retail URL) - Retail packaging of standard description here
-* [Any other parts this repo covers](any other URLs) - Description of said parts
-
-Version History
----------------
-* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description 
-* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description
+* [SEN-23517](https://www.sparkfun.com/products/23517) - Spectral UV Sensor - AS7331 (Qwiic)
+* [SEN-23518](https://www.sparkfun.com/products/23518) - Mini Spectral UV Sensor - AS7331 (Qwiic)
 
 License Information
 -------------------
@@ -49,5 +45,3 @@ If you have any questions or concerns on licensing, please contact technical sup
 Distributed as-is; no warranty is given.
 
 - Your friends at SparkFun.
-
-_<COLLABORATION CREDIT>_

README.md

@@ -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_Spectral_UV_Sensor_AS7331>/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331.svg" /></a>
+Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331.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_Spectral_UV_Sensor_AS7331>/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>).
+* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/tree/main/docs) of the [SparkFun Spectral UV Sensor - AS7331 repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331).
 
 <!-- ### :material-source-pull:&nbsp;Submit a Correction -->
 ### Submit a Correction
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/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_Spectral_UV_Sensor_AS7331>/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>).
+* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/tree/main/Hardware) of the [SparkFun Spectral UV Sensor - AS7331 repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331).
 
 <!-- ### :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_Spectral_UV_Sensor_AS7331>/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/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_Spectral_UV_Sensor_AS7331>)
+![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_Spectral_UV_Sensor_AS7331)
 <br>
-<a href="https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>.svg" /></a>
+<a href="https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331.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_Spectral_UV_Sensor_AS7331>/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>.svg" /></a>
+Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331.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/<
 
 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_Spectral_UV_Sensor_AS7331>/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>).
+* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/tree/main/docs) of the [SparkFun Spectral UV Sensor - AS7331 repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331).
 
 ### 🔍 Spot something wrong?
 
-If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>/issues) and let us know.
+If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/issues) and let us know.
 
 ### Do you have a suggested correction?
 
-1. With a GitHub account, [fork this repository](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/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_Spectral_UV_Sensor_AS7331>/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>).
+* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/tree/main/Hardware) of the [SparkFun Spectral UV Sensor - AS7331 repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331).
 
 ### Does something not make sense? 🤔
 
-If part of the design is confusing, please [open an issue](https://github.com/sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>/issues) and let us know.
+If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/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_Spectral_UV_Sensor_AS7331>/issues) and file a feature request.
+If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/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_Spectral_UV_Sensor_AS7331>/fork).
+1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Spectral_UV_Sensor_AS7331/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

@@ -261,7 +261,7 @@ We designed this board for integration into SparkFun's Qwiic connect system.  Cl
 <table>
   <tr>
    <td>
-   <div style="text-align: center"><a href="https://www.sparkfun.com/qwiic"><img src="./assets/img/Qwiic-registered-updated.png" alt= "Qwiic Connect System" title= "Click to learn more about the Qwiic Connect System!"></a></div>
+   <div style="text-align: center"><a href="https://www.sparkfun.com/qwiic"><img src="../assets/img/Qwiic-registered-updated.png" alt="Qwiic Connect System" title="Click to learn more about the Qwiic Connect System!"></a></div>
    </td>
   </tr>
   <tr>

docs/introduction.md

@@ -5,7 +5,7 @@ hide:
 icon: fontawesome/solid/scroll
 ---
 
-
+# Introduction
 --8<-- "./docs/introduction.md:5"
 
 # Hardware Overview

docs/single_page.md

@@ -154,7 +154,7 @@ plugins:
       type: timeago
   # Add git committers at the bottom of the page
   - git-committers:
-      repository: sparkfun/<SparkFun_Spectral_UV_Sensor_AS7331>
+      repository: sparkfun/SparkFun_Spectral_UV_Sensor_AS7331
       branch: main
   # Add git authors at the bottom of the page
   - git-authors
@@ -219,7 +219,7 @@ extra:
   # Configures social icons in the footer
   social:
     - icon: sfe-logo # simple/sparkfun
-      link: https://www.sparkfun.com/products/<SKU Number>
+      link: https://www.sparkfun.com/products/23517
     - icon: fontawesome/brands/youtube
       link: https://www.youtube.com/sparkfun
     - icon: fontawesome/brands/instagram

mkdocs.yml

@@ -4,7 +4,7 @@
 
 <!-- Adds file-eye icon to view hookup guide as a single page -->
 {% if "single_page.md" %}
-    <a href="/<SparkFun_Spectral_UV_Sensor_AS7331>/single_page" title="View as Single-Page" class="md-content__button md-icon">
+    <a href="/SparkFun_Spectral_UV_Sensor_AS7331/single_page" title="View as Single-Page" class="md-content__button md-icon">
         {% include ".icons/material/file-eye-outline.svg" %}
     </a>
 {% endif %}