Docs update

Quick start guide review edits. Adding GH pages build files.

Author: SFEMark

.github/workflows/build_documentation.yml

@@ -0,0 +1,50 @@
+name: Build Documentation
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# 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: Instal 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 --clean

README.md

@@ -1,41 +1,25 @@
-SparkFun <PRODUCT NAME>
-========================================
+[![SparkFun Teensy Ethernet Adapter](./docs/assets/img/Ethernet_Adapter-GH_Banner.png)](https://www.sparkfun.com/sparkfun-ethernet-adapter-for-teensy.html)
 
-[![SparkFun Part Name](URL for picture of part)](URL for product on Sparkfun.com)
-
-[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com)
+[*SparkFun Teensy Ethernet Adapter (PRT-29920)*](https://www.sparkfun.com/sparkfun-ethernet-adapter-for-teensy.html)
 
 <Basic description of the part.>
 
 Repository Contents
 -------------------
 
+* **/docs** - Tutorial content files
 * **/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>
 
 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.
+* **[Quick Start Guide](Learn.SparkFun URL)** - A quick guide to get started with the SparkFun Teensy Ethernet Adapter.
 
 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
+* [PRT-29920](https://www.sparkfun.com/sparkfun-ethernet-adapter-for-teensy.html) - Initial release of SparkFun Teensy Ethernet Adapter
 
-Version History
----------------
-* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description 
-* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description
 
 License Information
 -------------------
@@ -48,6 +32,4 @@ 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>_
+- Your friends at SparkFun.

docs/assets/img/Ethernet_Adapter-Serial.png

@@ -76,6 +76,21 @@ If the Ethernet library is not already installed, open the "Library Manager" too
 
 ## Arduino Example
 
-Now that we have everything assembled, connected and installed, let's run a quick test sketch in Arduino to make sure we can connect to the Internet. For this we'll use the **WebClient** example included in the **Ethernet Arduino Library** to connect to a website (in this case, http://www.google.com). Open the example by navigating to **File** > **Examples** > **Ethernet** > **WebClient**. Select your Board and Port and click the "Upload" button.
+Now that we have everything assembled, connected and installed, let's run a quick test sketch in Arduino to make sure we can connect to the Internet. For this we'll use the **WebClient** example included in the **Ethernet Arduino Library** to connect to a website (in this case, http://www.pjrc.com) and print out . Open the example by navigating to **File** > **Examples** > **Ethernet** > **WebClient**. Select your Board and Port and click the "Upload" button.
 
-After the code finishes compiling and uploading, open the [serial monitor](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-serial-monitor/) with the baud set to **9600**. 
+After the code finishes compiling and uploading, open the [serial monitor](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-serial-monitor/) with the baud set to **9600**. The example attempts to 
+
+<figure markdown>
+[![Screenshot of WebClient serial printout](./assets/img/Ethernet_Adapter-Serial.png){ width="600"}](./assets/img/Ethernet_Adapter-Serial.png "Click to enlarge")
+</figure>
+
+### Code to Note
+
+You may notice in the screenshot above that the Teensy is connecting to "www.pjrc.com" instead of "www.google.com". The code defaults to use DNS to connect to a website here:
+
+``` c++
+//IPAddress server(74,125,232,128);  // numeric IP for Google (no DNS)
+char server[] = "www.google.com";    // name address for Google (using DNS)
+```
+
+You can enter any full web address here so we changed it to PJRC's website. Alternatively, you can uncomment the <code>IPAddress server ();</code> line and comment out the <code>char server[] = "www.google.com";</code> to connect directly to an IP address and bypass DNS to reduce the size of the sketch.