Update docs

nseidle · nseidle · commit 0e777d9f45e1 · 2022-05-27T16:13:37.000-06:00
diff --git a/Binaries/readme.md b/Binaries/readme.md
@@ -1,24 +1,3 @@
 This folder contains the various firmware versions for RTK Products (Surveyor, Express, Express+, and Facet). 
 
-Updating the firmware can be achieved by using one of the following methods:
-
-* Load the firmware on an SD card, then use a serial terminal with *Firmware Upgrade* menu
-* Load the firmware over WiFi when the device is in WiFi AP Config Mode
-* Use the [Windows GUI](https://github.com/sparkfun/SparkFun_RTK_Firmware/Uploader_GUI) and a USB cable. (This method is python based which can also be used on Linux, Mac OS, and Raspberry Pi)
-* Use the command line *batch_program.bat* (see below)
-
-The SD method is generally recommended. For more information see [here](https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide/firmware-updates-and-customization).
-
-Each binary is created by exporting a sketch binary from Arduino. The sketch binary is then uploaded to the ESP32 along with boot_app0.bin, RTK_Surveyor.ino.bootloader.bin, and RTK_Surveyor.ino.partitions.bin. You can update the firmware on a device by loading a binary onto the SD card and inserting it into the RTK Surveyor ) or by using the included 'batch_program.bat' along with the binary file name and COM port. For example *batch_program.bat RTK_Surveyor_Firmware_v2_0.bin COM3*.
-
-The batch file runs the following commands:
-
-esptool.exe --chip esp32 --port COM4 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size detect 0x1000 ./bin/RTK_Surveyor.ino.bootloader.bin 0x8000 ./bin/RTK_Surveyor.ino.partitions.bin 0xe000 ./bin/boot_app0.bin 0x10000 ./RTK_Surveyor_Firmware_vxx.bin
-
-Where *COM4* is replaced with the COM port that the RTK product enumerated at and *RTK_Surveyor_Firmware_vxx.bin* is the firmware you would like to load.
-
----------------------
-
-### Force Firmware Loading
-
-In the rare event a unit is not staying on long enough for new firmware to be loaded into a COM port, the RTK Firmware (as of version 1.2) has an override function. If a file named *RTK_Surveyor_Firmware_Force.bin* is detected on the SD card at boot that file will be used to overwrite the current firmware, and then be deleted. This update path is generally not recommend. Use the [WiFi OTA method](https://learn.sparkfun.com/tutorials/sparkfun-rtk-facet-hookup-guide/all#firmware-updates-and-customization) or via the serial menu as first resort.
+Please see [Updating RTK Firmware](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/) for a description of how to use these files.
diff --git a/Uploader_GUI/readme.md b/Uploader_GUI/readme.md
@@ -1,23 +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.
 
-![SparkFun RTK Firmware GUI](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun RTK Firmware Uploader.jpg)
-
-The tool is based on the esptool.py and loads RTK_Surveyor.ino.bootloader.bin and RTK_Surveyor.ino.partitions.bin files along side the chosen firmware file. This tool was created to aid users in updating their firmware. In general, the SD firmware update method is recommended, but for some firmware updates (for example from version v1.x to v2.x) a serial connection via USB is required. This GUI makes it easy to point and click your way through a firmware update.
-
-### To Use
-
-* Attach the RTK device to your computer using a USB cable. 
-* Turn the RTK device on.
-* Open Device Manager to confirm which COM port the device is operating on.
-
-![Device Manager showing USB Serial port on COM27](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun RTK Firmware Uploader COM Port.jpg)
-
--> *Device Manager showing USB Serial port on COM27* <-
-
-* Get the latest binary firmware file from the *[Binaries](https://github.com/sparkfun/SparkFun_RTK_Firmware/tree/main/Binaries)* folder.
-* Run *RTK_Firmware_Uploader_GUI.exe* (it takes a few seconds to start)
-* Click *Browse* and select the binary file to upload
-* Select the COM port previously seen in the Device Manager.
-* Click *Upload Firmware*
-
-Once complete, the device will reset and power down.
+For more information, see [Updating Fimrware From GUI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-gui).
diff --git a/docs/contribute.md b/docs/contribute.md
@@ -1,9 +1,7 @@
 # Fix That Typo!
 
-See a typo?
- 
 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 and let us know.
+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.
diff --git a/docs/firmware_update.md b/docs/firmware_update.md
@@ -34,6 +34,10 @@ The firmware upgrade menu will only display files that have the "RTK_Surveyor_Fi
 
 Note: The firmware is called `RTK_Surveyor_Firmware_vXX.bin` even though this product is called the *RTK Facet*. We united the different platforms into one. The [RTK Firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) runs on all our RTK products.
 
+### Force Firmware Loading
+
+In the rare event a unit is not staying on long enough for new firmware to be loaded into a COM port, the RTK Firmware (as of version 1.2) has an override function. If a file named *RTK_Surveyor_Firmware_Force.bin* is detected on the SD card at boot that file will be used to overwrite the current firmware, and then be deleted. This update path is generally not recommend. Use the [GUI](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-gui) or [WiFi OTA](https://sparkfun.github.io/SparkFun_RTK_Firmware/firmware_update/#updating-firmware-from-wifi) methods as first resort.
+
 ## Updating Firmware From WiFi
 
 **Note:** Firmware versions 1.1 to 1.9 have an issue that severely limit firmware upload over WiFi and is not recommended; use the 'Updating Firmware From the SD Card' method instead. Firmware versions v1.10 and beyond support direct firmware update via WiFi and is the preferred method for updating the firmware on a unit.
@@ -62,7 +66,7 @@ In general, the SD firmware update method is recommended, but for some firmware
 * Turn the RTK device on.
 * Open Device Manager to confirm which COM port the device is operating on.
 
-![Device Manager showing USB Serial port on COM27](https://github.com/sparkfun/SparkFun_RTK_Firmware/blob/release_candidate/Uploader_GUI/SparkFun RTK Firmware Uploader COM Port.jpg)
+![Device Manager showing USB Serial port on COM27](https://raw.githubusercontent.com/sparkfun/SparkFun_RTK_Firmware/main/docs/img/SparkFun RTK Firmware Uploader COM Port.jpg)
 
 *Device Manager showing USB Serial port on COM27*
 
diff --git a/docs/img/SparkFun RTK Firmware Uploader COM Port.jpg b/docs/img/SparkFun RTK Firmware Uploader COM Port.jpg
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -97,6 +97,5 @@ nav:
     - hardware_rtk_express.md
     - hardware_rtk_express_plus.md
     - hardware_rtk_facet.md
-    - contribute.md
-
+    
     
