Update docs

Author: nseidle

Firmware/readme.md

@@ -1,55 +1,10 @@
-### Firmware
+# Firmware
 
-There are two firmwares that operate on the device:
-
-* Firmware on the ZED-F9P Receiver
-* Firmware on the ESP32 microcontroller
-
-This folder contains the firmware for the ESP32
+This folder contains the Arduino sketches that make up the firmware that runs on the ESP32. Go [here](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#zed-f9x-firmware) for more information about the firmware that runs the ZED-F9x Receiver.
 
 * **RTK_Surveyor** - The main firmware for the RTK Surveyor
 * **Test Sketches** - Various sketches used in the making of the main firmware. Used internally to verify different features. Reader beware.
 
-----
-### Compilation Instructions
-
-The SparkFun RTK firmware is compiled using Arduino (currently v1.8.15). To compile:
-
-1. Install [Arduino](https://www.arduino.cc/en/software). 
-2. Install ESP32 for Arduino. [Here](https://learn.sparkfun.com/tutorials/esp32-thing-hookup-guide#installing-via-arduino-ide-boards-manager) are some good instructions for installing it via the Arduino Boards manager. **Note**: Use v2.0.2 of the core. **Note:** We use the 'ESP32 Dev Module' for pin numbering. Select the correct board under Tools->Board->ESP32 Arduino->ESP32 Dev Module.
-3. Change the Parition table. Replace 'C:\Users\\[user name]\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.2\tools\partitions\app3M_fat9M_16MB.csv' with the app3M_fat9M_16MB.csv file found in this folder. This will increase the program partition from a maximum of 1.9MB to 3MB.
-4. Set the core settings: The 'Partition Scheme' must be set to '16M Flash (3MB APP/9MB FATFS)'. This will use the 'app3M_fat9M_16MB.csv' updated partition table.
-5. Set the 'Flash Size' to 16MB (128mbit)
-6. Obtain all the required libraries. **Note:** You should click on the link next to each of the #includes at the top of RTK_Surveyor.ino within the Arduino IDE to open the library manager and download them. Getting them directly from github also works but may not be 'official' releases:
-    * [ESP32Time](https://github.com/fbiego/ESP32Time)
-    * [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer) (not available via library manager)
-    * [AsyncTCP](https://github.com/me-no-dev/AsyncTCP) (not available via library manager)
-    * [JC_Button](https://github.com/JChristensen/JC_Button)
-    * [SdFat](https://github.com/greiman/SdFat)
-    * [SparkFun u-blox GNSS Arduino Library](https://github.com/sparkfun/SparkFun_u-blox_GNSS_Arduino_Library)
-    * [SparkFun MAX1704x Fuel Gauge Arduino Library](https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library)
-    * [SparkFun Micro OLED Arduino Library](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library) -  Note the Arduino Library manager lists this as 'SparkFun Micro OLED Breakout'
-    * [SparkFun LIS2DH12 Accelerometer Arduino Library](https://github.com/sparkfun/SparkFun_LIS2DH12_Arduino_Library)
-
-Once compiled, firmware can be uploaded directly to a unit when the RTK unit is on and the correct COM port is selected under the Arduino IDE Tools->Port menu.
-
-Note: The COMPILE_WIFI and COMPILE_BT defines at the top of RTK_Surveyor.ino can be commented out to remove them from compilation. This will greatly reduce the firmware size and allow for faster development of functions that do not rely on WiFi or Bluetooth (serial menus, system configuration, logging, etc).
-
-----
-### A note about ZED-F9P firmware
-
-The firmware loaded onto the ZED-F9P receiver can vary depending on manufacture date. All field testing and device specific performance parameters were obtained with v1.30.
-
-v1.12 has the benefit of working with SBAS and an operational RTK status signal (the LED illuminates correctly). See [release notes](https://content.u-blox.com/sites/default/files/ZED-F9P-FW100-HPG112_RN_%28UBX-19026698%29.pdf).
-
-v1.13 has a few RTK and receiver performance improvements but introduces a bug that causes the RTK Status LED to fail when SBAS is enabled. See [release notes](https://content.u-blox.com/sites/default/files/ZED-F9P-FW100-HPG113_RN_%28UBX-20019211%29.pdf).
-
-v1.30 has a few RTK and receiver performance improvements, I<sup>2</sup>C communication improvements, and most importantly support for Spartan PMP packets. See [release notes](https://www.u-blox.com/sites/default/files/ZED-F9P-FW100-HPG130_RN_UBX-21047459.pdf).
-
-v1.32 has a few Spartan protocol specific improvements. See [release notes](https://www.u-blox.com/sites/default/files/documents/ZED-F9P-FW100-HPG132_RN_UBX-22004887.pdf).
-
-The RTK Firmware is designed to work with any ZED-F9x firmware. Upgrading the ZED-F9x is a good thing to consider but is not crucial to the use of the RTK products.
-
-A tutorial with step-by-step instructions for locating the firmware version as well as changing the firmware can be found [here](https://learn.sparkfun.com/tutorials/how-to-upgrade-firmware-of-a-u-blox-gnss-receiver).
+## Compilation Instructions
 
-More information about the differences can be found [here](https://content.u-blox.com/sites/default/files/ZED-F9P-FW100-HPG130_RN_UBX-21047459.pdf).
+See [Compiling from Source](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#compiling-from-source) for detailed steps.

Uploader_GUI/readme.md

@@ -1,3 +1,3 @@
 This folder contains the python based GUI for updating firmware. There is an executable available for Windows and a python script available for Linux, Mac OS, and Raspberry Pi.
 
-For more information, see [Updating Fimrware From GUI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-gui).
+For more information, see [Updating Firmware From GUI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-gui).

docs/configure_base.md

@@ -2,7 +2,7 @@
 
 Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Not Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/RedDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
 
-In addition to providing accurate local location fixes, the SparkFun RTK devices can also serve as a correction source, also called a *Base*. The Base doesn't move and 'knows' where it is so it can calculate the discrepancies between the signals it is receiving and what it should be receiving. Said differently, the 'Base' is told where it is, and that it's not moving. If the GPS signals say otherwise, the Base knows there was a disturbance in the ~~Force~~ Ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter level accuracy.
+In addition to providing accurate local location fixes, the SparkFun RTK devices can also serve as a correction source, also called a *Base*. The Base doesn't move and 'knows' where it is so it can calculate the discrepancies between the signals it is receiving and what it should be receiving. Said differently, the 'Base' is told where it is, and that it's not moving. If the GPS signals say otherwise, the Base knows there was a disturbance in the ~~Force~~ ionosphere. These differences are the correction values passed to the Rover so that the Rover can have millimeter level accuracy.
 
 There are two types of bases: *Surveyed* and *Fixed*. A surveyed base is often a temporary base setup in the field. Called a 'Survey-In', this is less accurate but requires only 60 seconds to complete. The 'Fixed' base is much more accurate but the precise location at which the antenna is located must be known. A fixed base is often a structure with an antenna bolted to the side. Raw satellite signals are gathered for a few hours then processed using Precision Point Position. We have a variety of tutorials that go into depth on these subjects but all you need to know is that the RTK Facet supports both Survey-In and Fixed Base techniques.
 

docs/configure_gnss.md

@@ -1,4 +1,4 @@
-# GNSS Receiver Menu
+# GNSS Menu
 
 Surveyor: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Express Plus: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png) / Facet: ![Feature Supported](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/GreenDot.png)
 

docs/contribute.md

@@ -4,4 +4,4 @@ All of this documentation can be modified by you! Please help us make it better.
 
 Does something not make sense? If a section is confusing please [open an issue](https://github.com/sparkfun/SparkFun_RTK_Firmware/issues) and let us know.
 
-These pages are contained in the [docs folder](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/docs) of the [SparkFun RTK Firwmare](https://github.com/sparkfun/SparkFun_RTK_Firmware) repository. Fork this repo, make changes to the markdown, then create a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
+These pages are contained in the [docs folder](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/docs) of the [SparkFun RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) repository. Fork this repo, make changes to the markdown, then create a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.

docs/readme.md

@@ -0,0 +1 @@
+This folder contains the markdown files for the [RTK Product Manual](https://sparkfun.github.io/SparkFun_RTK_Firmware/intro/) that are rendered by [mkdocs](https://www.mkdocs.org/).

mkdocs.yml

@@ -97,5 +97,3 @@ nav:
     - hardware_rtk_express.md
     - hardware_rtk_express_plus.md
     - hardware_rtk_facet.md
-    
-