Implement Admonitions

Replace all instances of "Note:", "Tip:", examples, etc. to utilize admonition feature of mkdocs-material theme

Author: santaimpersonator

docs/accuracy_verification.md

@@ -163,7 +163,8 @@ We can see the approximate location of the monument in the above location.
 
 *Screenshot of a point in time*
 
-Note the 8 decimal places on the Lat/Long.
+!!! note
+	Note the significant figures of the Lat/Long, result in 8 decimal places.
 
 Screenshots are an easy way to record lat/long/alt but SW Maps (and other GIS software) allows the averaging of a position. Choose your own adventure. For our example, we took screenshots/snapshots of the location. Some surveyors hold a position for multiple minutes to get a point; we can do the same in under a second.
 

docs/configure_with_bluetooth.md

@@ -30,7 +30,8 @@ The RTK device will be a discoverable Bluetooth device (both BT SPP and BLE are
 
 Once connected, the RTK device will report a large amount of NMEA data over the link. To enter Bluetooth Echo Mode send the characters +++.
 
-**Note:** There must be a 2 second gap between any serial sent from a phone to the RTK device, and any escape characters. In almost all cases this is not a problem. Just be sure it's been 2 seconds since an NTRIP source has been turned off and attempting to enter Bluetooth Echo Mode.
+!!! note
+	There must be a 2 second gap between any serial sent from a phone to the RTK device, and any escape characters. In almost all cases this is not a problem. Just be sure it's been 2 seconds since an NTRIP source has been turned off and attempting to enter Bluetooth Echo Mode.
 
 ![The GNSS message menu over BEM](img/Bluetooth/SparkFun%20RTK%20BEM%20-%20Config%20Menu.png)
 

docs/configure_with_cli.md

@@ -54,15 +54,16 @@ If there was an error in getting the setting value, such as the setting name bei
 
 	$SPGET,[setting name],,ERROR,[Verbose error description]*FF<CR><LF>
 
-For example, to get the elevation mask:
+!!! example
+	For example, to get the elevation mask:
 
-Send:
+	Send:
 
-	$SPGET,elvMask*32<CR><LF>
+		$SPGET,elvMask*32<CR><LF>
 
-Receive:
+	Receive:
 
-	$SPGET,elvMask,15*1A<CR><LF>
+		$SPGET,elvMask,15*1A<CR><LF>
 
 If a setting is a string, the setting will be surrounded in quotes. Any internal quotes will be escaped.
 
@@ -88,15 +89,16 @@ If there was an error in setting the value, such as the setting name being unkno
 
 	$SPSET,[setting name],[optional: current value],ERROR,[Verbose error description]*FF<CR><LF>
 
-For example, to set the elevation mask:
+!!! example
+	For example, to set the elevation mask:
 
-Send:
+	Send:
 
-	$SPSET,elvMask,15*0E<CR><LF>
+		$SPSET,elvMask,15*0E<CR><LF>
 
-Receive:
+	Receive:
 
-	$SPSET,elvMask,15,OK*26<CR><LF>
+		$SPSET,elvMask,15,OK*26<CR><LF>
 
 Using the $SPSET command only sets the configuration value in the firmware memory. The settings are not applied until an APPLY action is executed.
 
@@ -186,15 +188,16 @@ The $SPLST sentences shall have the following structure:
 
 The data type contains whether the field is a char[n], int, bool, or float.
 
-Example response:
-
-	$SPLST,enableSD,bool,true*6A<CR><LF>
-	$SPLST,enableDisplay,bool,true*27<CR><LF>
-	$SPLST,maxLogTime_minutes,int,1*01<CR><LF>
-	$SPLST,maxLogLength_minutes,int,10*38<CR><LF>
-	$SPLST,observationSeconds,int,10*37<CR><LF>
-	$SPLST,observationPositionAccuracy,float,0.5*59<CR><LF>
-	.
-	.
-	.
-	$SPEXE,LIST,OK*5D<CR><LF>
+!!! example
+	Example response:
+
+		$SPLST,enableSD,bool,true*6A<CR><LF>
+		$SPLST,enableDisplay,bool,true*27<CR><LF>
+		$SPLST,maxLogTime_minutes,int,1*01<CR><LF>
+		$SPLST,maxLogLength_minutes,int,10*38<CR><LF>
+		$SPLST,observationSeconds,int,10*37<CR><LF>
+		$SPLST,observationPositionAccuracy,float,0.5*59<CR><LF>
+		.
+		.
+		.
+		$SPEXE,LIST,OK*5D<CR><LF>

docs/configure_with_serial.md

@@ -16,7 +16,8 @@ Compatibility Icons
 
 </div>
 
-**Note:** Any serial menu that is shown below can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
+!!! note
+	Any serial menu that is shown below can also be accessed over Bluetooth. This makes any configuration of a device much easier in the field. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
 
 To configure an RTK device using serial attach a [USB C cable](https://www.sparkfun.com/products/15425) to the device.
 
@@ -35,7 +36,8 @@ Pull back the silicone cover and insert a USB C and power on the device. Once th
 
 Configuring the RTK device is done over the *USB-Enhanced-SERIAL-B CH342* COM port via the serial text menu. Various debug messages are printed to this port at 115200bps and a serial menu can be opened to configure advanced settings.
 
-**Don't See 'USB-Enhanced-SERIAL-B CH342'?** If you've never connected a CH34x device to your computer before, you may need to install drivers for the USB-to-serial converter. Check out our section on <a href="https://learn.sparkfun.com/tutorials/sparkfun-serial-basic-ch340c-hookup-guide#drivers-if-you-need-them">"How to Install CH340 Drivers"</a> for help with the installation.
+!!! tip "Don't See 'USB-Enhanced-SERIAL-B CH342'?"
+	If you've never connected a CH34x device to your computer before, you may need to install drivers for the USB-to-serial converter. Check out our section on <a href="https://learn.sparkfun.com/tutorials/sparkfun-serial-basic-ch340c-hookup-guide#drivers-if-you-need-them">"How to Install CH340 Drivers"</a> for help with the installation.
 
 ## Terminal Window
 
@@ -47,7 +49,10 @@ Note that some Windows terminal programs (e.g. Tera Term) may reboot the RTK dev
 
 *The Main Menu*
 
-Pressing any button will display the Main menu. The Main menu will display the current firmware version and the Bluetooth broadcast name. Note: When powered on, the RTK device will broadcast itself as either *[Platform] Rover-XXXX* or *[Platform] Base-XXXX* depending on which state it is in. The Platform is 'Torch', 'EVK', etc.
+Pressing any button will display the Main menu. The Main menu will display the current firmware version and the Bluetooth broadcast name.
+
+!!! note
+	 When powered on, the RTK device will broadcast itself as either *[Platform] Rover-XXXX* or *[Platform] Base-XXXX* depending on which state it is in. The Platform is 'Torch', 'EVK', etc.
 
 Pressing '1' or 's' for example, will open those submenus.
 
@@ -57,7 +62,8 @@ The menus will timeout after 10 minutes of inactivity, so if you do not press a
 
 *Configuration menu via Bluetooth*
 
-**Note:** Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
+!!! note
+	Bluetooth-based configuration is supported. Please see [Configure With Bluetooth](configure_with_bluetooth.md) for more information.
 
 ## System Report
 
@@ -67,24 +73,26 @@ Sending the `~` character to the device over the serial port will trigger a syst
 
 *Terminal showing System Status*
 
-Below is an example system status report sentence:
-
-> $GNTXT,01,01,05,202447.00,270522,0.380,29,40.090355193,-105.184764700,1560.56,3,0,86*71
-
-* $GNTXT : Start of custom NMEA sentence
-* 01 : Number of sentences
-* 01 : Sentence number
-* 05 : Sentence type ID (5 is for System Status messages)
-* 202447.00 : Current hour, minute, second, milliseconds
-* 270522 : Current day, month, year
-* 0.380 : Current horizontal positional accuracy (m)
-* 29 : Satellites in view
-* 40.090355193 : Latitude
-* -105.184764700 : Longitude
-* 1560.56 : Altitude
-* 3 : Fix type (0 = no fix, 2 = 2D fix, 3 = 3D fix, 4 = 3D + Dead Reackoning, 5 = Time)
-* 0 : Carrier solution (0 = No RTK, 1 = RTK Float, 2 = RTK Fix)
-* 86 : Battery level (% remaining)
-* *71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
-
-**Note:** This is a custom NMEA sentence, can vary in length, and may exceed the [maximum permitted sentence length](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) of 61 characters.
+!!! example
+	Below is an example system status report sentence:
+
+	> $GNTXT,01,01,05,202447.00,270522,0.380,29,40.090355193,-105.184764700,1560.56,3,0,86*7	1
+	
+	* $GNTXT : Start of custom NMEA sentence	
+	* 01 : Number of sentences	
+	* 01 : Sentence number	
+	* 05 : Sentence type ID (5 is for System Status messages)	
+	* 202447.00 : Current hour, minute, second, milliseconds	
+	* 270522 : Current day, month, year	
+	* 0.380 : Current horizontal positional accuracy (m)	
+	* 29 : Satellites in view	
+	* 40.090355193 : Latitude	
+	* -105.184764700 : Longitude	
+	* 1560.56 : Altitude	
+	* 3 : Fix type (0 = no fix, 2 = 2D fix, 3 = 3D fix, 4 = 3D + Dead Reackoning, 5 = Time)	
+	* 0 : Carrier solution (0 = No RTK, 1 = RTK Float, 2 = RTK Fix)
+	* 86 : Battery level (% remaining)
+	* *71 : The completion of the sentence and a [CRC](http://engineeringnotes.blogspot.com/2015/02/generate-crc-for-nmea-strings-arduino.html)
+
+!!! note
+	This is a custom NMEA sentence, can vary in length, and may exceed the [maximum permitted sentence length](https://www.nmea.org/Assets/20160520%20txt%20amendment.pdf) of 61 characters.

docs/configure_with_settings_file.md

@@ -22,25 +22,33 @@ Compatibility Icons
 
 All device settings are stored both in internal memory and an SD card (if supported and if one is detected). The device will load the latest settings at each power on. If there is a discrepancy between the internal settings and an external settings file then the external settings file will be used. This allows a collection of RTK products to be identically configured using one 'golden' settings file loaded onto an SD card.
 
-All system configuration can be done by editing the *SFE_[Platform]_Settings_0.txt* file (example shown above) where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). This file is created when a microSD card is installed. The settings are clear text but there are no safety guards against setting illegal states. It is not recommended to use this method unless You Know What You're Doing®.
+All system configuration can be done by editing the *SFE_[Platform]_Settings_0.txt* file (example shown above) where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). This file is created when a microSD card is installed.
+
+!!! failure "Danger"
+	The settings are clear text but there are no safety guards against setting illegal states. It is not recommended to use this method unless You Know What You're Doing®.
 
 Keep in mind:
 
 * Not all devices have an SD card slot (ie, RTK Torch) and therefore do not support this configuration method.
 * The settings file contains hundreds of settings.
-* The SD card file "SFE_EVK_Settings_0.txt" is used for Profile 1, SD card file "SFE_EVK_Settings_1.txt" is used for Profile 2, etc. (note that setting 0 is for profile 1, ...)
+* The SD card file "SFE_EVK_Settings_0.txt" is used for Profile 1, SD card file "SFE_EVK_Settings_1.txt" is used for Profile 2, etc.
+
+	!!! note
+		The `Settings_0` is for **Profile 1**, `Settings_1` is for **Profile 2**, `Settings_2` is for **Profile 3**...
+
 * When switching to a new profile, the settings file on the SD card with all settings will be created or updated. The internal settings will not be updated until you switch to the profile. Additionally, the file for a particular profile will not be created on the SD card until you switch to that profile.
 * It is not necessary that the settings file on the SD card have all of the settings.
 
-For example, if you only wanted to set up two wireless networks for profile 2, you could create a file named "SFE_Express_Settings_1.txt" that only contained the following settings:
+!!! example
+	For example, if you only wanted to set up two wireless networks for **Profile 2**, you could create a file named `SFE_Express_Settings_1.txt` that only contained the following settings:
 
-	profileName=a name you choose
-	enableTcpServer=1
-	wifiNetwork0SSID=your SSID name 1
-	wifiNetwork0Password=your SSID password 1
-	wifiNetwork1SSID=your SSID name 2
-	wifiNetwork1Password=your SSID password 2
-	wifiConfigOverAP=0
+		profileName=a name you choose
+		enableTcpServer=1
+		wifiNetwork0SSID=your SSID name 1
+		wifiNetwork0Password=your SSID password 1
+		wifiNetwork1SSID=your SSID name 2
+		wifiNetwork1Password=your SSID password 2
+		wifiConfigOverAP=0
 
 These settings on the SD card will overwrite the settings in the RTK Express internal memory. Once you select this profile on your RTK Express, the SD card file will be overwritten with all of the merged settings.
 
@@ -50,4 +58,5 @@ These settings on the SD card will overwrite the settings in the RTK Express int
 
 If the device has been configured into an unknown state the device can be reset to factory defaults. Power down the RTK device and remove the SD card. Using a computer and an SD card reader, open the SFE_[Platform]_Settings_0.txt file where [Platform] is Facet, Express, Surveyor, etc and 0 is the profile number (0, 1, 2, 3). Modify the **sizeOfSettings** value to -1 and save the file to the SD card. Reinsert the SD card into the RTK unit and power up the device. Upon power up, the device will display 'Factory Reset' while it clears the settings.
 
-Note: A device may have multiple profiles, ie multiple settings files (SFE_EVK_Settings_**0**.txt, SFE_EVK_Settings_**1**.txt, etc). All settings files found on the SD card must be modified to guarantee the factory reset.
+!!! note
+	A device may have multiple profiles, ie multiple settings files (SFE_EVK_Settings_**0**.txt, SFE_EVK_Settings_**1**.txt, etc). All settings files found on the SD card must be modified to guarantee the factory reset.

docs/configure_with_wifi.md

@@ -67,7 +67,8 @@ To get into WiFi configuration follow these steps:
 
 *The WiFi network RTK Config as seen from a cellphone*
 
-Note: Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
+!!! note
+	Upon connecting, your phone may warn you that this WiFi network has no internet. That's ok. Stay connected to the network and open a browser. If you still have problems turn off Mobile Data so that the phone does not default to cellular for internet connectivity and instead connects to the RTK Device.
 
 ![Webpage showing the RTK Configuration options](<img/WiFi Config/SparkFun RTK WiFi Config - Main Interface.png>)
 
@@ -79,7 +80,8 @@ Clicking on the category tab will open or close that section. Clicking on an ‘
 
 *This unit has firmware version 1.0 and a UM980 GNSS receiver*
 
-Please note that the firmware for the RTK device and the firmware for the GNSS receiver is shown at the top of the page. This can be helpful when troubleshooting or requesting new features.
+!!! note
+	The firmware for the RTK device and the firmware for the GNSS receiver is shown at the top of the page. This can be helpful when troubleshooting or requesting new features.
 
 ## File Manager
 

docs/connecting_bluetooth.md

@@ -19,7 +19,8 @@ Compatibility Icons
 
 SparkFun RTK devices transmit full NMEA sentences over Bluetooth serial port profile (SPP) at 2Hz and 115200bps. This means that nearly any GIS application that can receive NMEA data over a serial port (almost all do) can be used with SparkFun RTK devices. As long as your end system can open a serial port over Bluetooth (also known as SPP) your system can retrieve industry-standard NMEA positional data. The following steps show how to connect an external tablet, or cell phone to the RTK device so that any serial port-based GIS application can be used.
 
-**Note**: BLE is also supported and can be used in place of Bluetooth SPP. See [Bluetooth Protocols](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_system/#bluetooth-protocol) for more information.
+!!! note
+	BLE is also supported and can be used in place of Bluetooth SPP. See [Bluetooth Protocols](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/menu_system/#bluetooth-protocol) for more information.
 
 ## Android
 
@@ -35,7 +36,8 @@ When powered on, the RTK product will broadcast itself as either '[Platform] Rov
 
 *Bluetooth MAC address B022 is shown in the upper left corner*
 
-**Note:** For devices with a built-in display, *B022* is the last four digits of your unit's MAC address and will be unique to the device in front of you. This is helpful in case there are multiple RTK devices within Bluetooth range.
+!!! note
+	For devices with a built-in display, *B022* is the last four digits of your unit's MAC address and will be unique to the device in front of you. This is helpful in case there are multiple RTK devices within Bluetooth range.
 
 ### Enable Mock Location
 
@@ -95,7 +97,8 @@ Click on the RTK device. When powered on, the RTK product will broadcast itself
 
 *Bluetooth MAC address B022 is shown in the upper left corner*
 
-**Note:** For devices with a built-in display, *B022* is the last four digits of your unit's MAC address and will be unique to the device in front of you. This is helpful in case there are multiple RTK devices within Bluetooth range.
+!!! note
+	For devices with a built-in display, *B022* is the last four digits of your unit's MAC address and will be unique to the device in front of you. This is helpful in case there are multiple RTK devices within Bluetooth range.
 
 ![Bluetooth Connection Success](img/Bluetooth/SparkFun%20RTK%20Software%20-%20Add%20Bluetooth%20Device%203.jpg)
 

docs/correction_sources.md

@@ -22,7 +22,11 @@ To get millimeter accuracy we need to provide the RTK unit with correction value
 
 These companies set up a large number of reference stations that cover entire regions and countries, but charge a monthly fee. They are often easy to use but can be expensive.
 
-* [PointPerfect](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/#pointperfect-corrections) ($8/month) - US, EU, as well as parts of Australia, Brazil, and South Korea. Note: This is an SSR service.
+* [PointPerfect](https://docs.sparkfun.com/SparkFun_RTK_Everywhere_Firmware/quickstart-torch/#pointperfect-corrections) ($8/month) - US, EU, as well as parts of Australia, Brazil, and South Korea.
+
+	!!! note
+		 This is an SSR service.
+
 * [Onocoy](https://console.onocoy.com/explorer) ($25/month) - US, EU, Australia, and many other partial areas
 * [PointOneNav](https://app.pointonenav.com/trial?src=sparkfun) ($50/month) - US, EU, Australia, South Korea
 * [Skylark](https://www.swiftnav.com/skylark) ($29 to $69/month) - US, EU, Japan, Australia

docs/displays.md

@@ -103,7 +103,8 @@ If the NTRIP server is enabled the device will first attempt to connect over WiF
 
 Once WiFi connects the device will attempt to connect to the NTRIP mount point. Once successful the display will show 'Casting' along with a solid WiFi icon. The number of successful RTCM transmissions will increase every second.
 
-Note: During NTRIP transmission WiFi is turned on and Bluetooth is turned off. You should not need to know the location information of the base so Bluetooth should not be needed. If necessary, USB can be connected to the USB port to view detailed location and ZED-F9P configuration information.
+!!! note
+	During NTRIP transmission WiFi is turned on and Bluetooth is turned off. You should not need to know the location information of the base so Bluetooth should not be needed. If necessary, USB can be connected to the USB port to view detailed location and ZED-F9P configuration information.
 
 ## L-Band
 

docs/embeddedsystem_connection.md

@@ -59,7 +59,8 @@ Connect the included [4-pin JST to breadboard cable](https://www.sparkfun.com/pr
 
 The Data connector on all RTK products is a 4-pin locking 1.25mm JST SMD connector (part#: SM04B-GHS-TB, mating connector part#: GHR-04V-S). **3.3V** is provided by this connector to power a remote device if needed. While the port is capable of sourcing up to 600mA, we do not recommend more than 300mA. This port should not be connected to a power source, so if your embedded device has its own power do not connect the red wire.
 
-**Warning!** All data in and out of RTK products is **3.3V**. Exposing these pins to **5V** or higher voltage logic will damage the device.
+!!! warning
+	All data in and out of RTK products is **3.3V**. Exposing these pins to **5V** or higher voltage logic will damage the device.
 
 The parsing of NMEA sentences is straightforward and left to the reader. There are ample NMEA parsing libraries available in C++, Arduino, Python, and many more languages.