Merge pull request #505 from sparkfun/docs_updates

PaulZC · web-flow · commit 00bdc2c3e8ff · 2023-06-22T10:25:13.000+01:00
Docs updates - make docs links relative
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ SparkFun RTK Firmware
   </tr>
 </table>
 
-The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), and [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Firmware/accuracy_verification/) at up to 20Hz!
+The [SparkFun RTK Surveyor](https://www.sparkfun.com/products/18443), [SparkFun RTK Express](https://www.sparkfun.com/products/18442), [SparkFun RTK Express Plus](https://www.sparkfun.com/products/18590), [SparkFun RTK Facet](https://www.sparkfun.com/products/19029), [SparkFun RTK Facet L-Band](https://www.sparkfun.com/products/20000) and [SparkFun RTK Reference Station](https://www.sparkfun.com/products/22429) are centimeter-level GNSS receivers. With RTK enabled, these devices can output your location with 14mm horizontal and vertical [*accuracy*](https://docs.sparkfun.com/SparkFun_RTK_Firmware/accuracy_verification/) at up to 20Hz!
 
 This repo houses the [RTK Product Manual](https://docs.sparkfun.com/SparkFun_RTK_Firmware/intro/) and the firmware that runs on the SparkFun RTK product line including:
 
diff --git a/docs/configure_data_logging.md b/docs/configure_data_logging.md
@@ -4,7 +4,7 @@ Surveyor: ![Feature Supported](img/GreenDot.png) / Express: ![Feature Supported]
 
 ## WiFi Interface
 
-Please see the System Menu [WiFi Interface](https://docs.sparkfun.com/SparkFun_RTK_Firmware/menu_system/#wifi-interface).
+Please see the System Menu [WiFi Interface](menu_system.md/#wifi-interface).
 
 ## Serial Interface
 
diff --git a/docs/configure_gnss.md b/docs/configure_gnss.md
@@ -52,7 +52,7 @@ The ZED-F9P is capable of tracking 184 channels across four constellations and t
 
 *NTRIP Client enabled showing settings*
 
-The SparkFun RTK devices can obtain their correction data over a few different methods. For detailed information see [Correction Sources](https://docs.sparkfun.com/SparkFun_RTK_Firmware/correction_sources/).
+The SparkFun RTK devices can obtain their correction data over a few different methods. For detailed information see [Correction Sources](correction_sources.md).
 
 * Bluetooth - This is the most common. An app running on a tablet or phone has an NTRIP client built into it. Once the phone is connected over Bluetooth SPP, the RTCM is sent from the phone to the RTK device.
 * Radio - A base RTK unit and a rover have serial radios plugged into the **RADIO** port. RTCM data generated by the base station is set over the radio to the rover.
diff --git a/docs/configure_ports.md b/docs/configure_ports.md
@@ -65,7 +65,7 @@ For PPS, only the Black and Green wires are needed. If you need to provide 3.3V
 * **Orange** - RX (input into the RTK device)
 * **Black** - GND
 
-Similarly, the RX pin of the DATA port can be used for event logging. See [External Event Logging](https://docs.sparkfun.com/SparkFun_RTK_Firmware/configure_ports/#external-event-logging) for more information.
+Similarly, the RX pin of the DATA port can be used for event logging. See [External Event Logging](configure_ports.md/#external-event-logging) for more information.
 
 ### External Event Logging
 
diff --git a/docs/configure_sensor.md b/docs/configure_sensor.md
@@ -14,6 +14,6 @@ Enable 'Sensor Fusion' to begin using the onboard IMU when GNSS is avaialble. Se
 
 'Automatic IMU-Mount Alignment' will allow the device to automatically determine how the product is mounted within the vehicle's frame of reference.
 
-Additionally, wheel ticks should be provided to the unit to enhance the positional fixes. Please see [Mux Channel](https://docs.sparkfun.com/SparkFun_RTK_Firmware/configure_ports/#mux-channel) of the Ports Menu for more information.
+Additionally, wheel ticks should be provided to the unit to enhance the positional fixes. Please see [Mux Channel](configure_ports.md/#mux-channel) of the Ports Menu for more information.
 
 
diff --git a/docs/menu_ethernet.md b/docs/menu_ethernet.md
@@ -9,9 +9,9 @@ By default, the Reference Station will use DHCP to request an IP Address from th
 
 ![Reference Station in DHCP mode](img/Ethernet_DHCP.png)
 
-**The Reference Station Ethernet menu - with DHCP selected**
+*The Reference Station Ethernet menu - with DHCP selected*
 
 ![Reference Station in fixed IP address mode](img/Ethernet_Fixed_IP.png)
 
-**The Reference Station Ethernet menu - with a fixed IP address selected**
+*The Reference Station Ethernet menu - with a fixed IP address selected*
 
diff --git a/docs/ntp.md b/docs/ntp.md
@@ -7,13 +7,13 @@ The Reference Station can act as an Ethernet Network Time Protocol (NTP) server.
 Network Time Protocol has been around since 1985. It is a simple way for computers to synchronize their clocks with each other, allowing the network latency (delay) to be subtracted:
 
 * A client sends a NTP request (packet) to the chosen or designated server
-  * The request contains the client's current clock time - for identification
+    * The request contains the client's current clock time - for identification
 
 * The server logs the time the client's request arrived and then sends a reply containing:
-  * The client's clock time - for identification
-  * The server's clock time - when the request arrived at the server
-  * The server's clock time - when the reply is sent
-  * The time the server's clock was last synchronized - providing the age of the synchronization
+    * The client's clock time - for identification
+    * The server's clock time - when the request arrived at the server
+    * The server's clock time - when the reply is sent
+    * The time the server's clock was last synchronized - providing the age of the synchronization
 
 * The client logs the time the reply is received - using its own clock
 
@@ -31,9 +31,9 @@ Having your own NTP server on your network allows tighter clock synchronization
 
 The Reference Station can be placed into its dedicated NTP mode, by pressing the **MODE** button until NTP is highlighted in the display and pausing there.
 
-![Animation of selecting NTP mode](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP.gif)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP.gif)
+[![Animation of selecting NTP mode](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP.gif)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP.gif)
 
-**Selecting NTP mode**
+*Selecting NTP mode*
 
 The Reference Station will first synchronize its Real Time Clock (RTC) using the very accurate time provided by the u-blox GNSS module. The module's Time Pulse (Pulse-Per-Second) signal is connect to the ESP32 as an interrupt. The ESP32's RTC is synchronized to Universal Time Coordinate (UTC) on the rising edge of the TP signal using the time contained in the UBX-TIM-TP message.
 
@@ -43,17 +43,17 @@ The Reference Station will respond to each NTP request within a few 10's of mill
 
 If desired, you can log all NTP requests to a file on the microSD card, and/or print them as diagnostic messages. The log and messages contain the NTP timing information and the IP Address and port of the Client.
 
-![The system debug menu showing how to enable the NTP diagnostics](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/3/2/1/0/NTP_Diagnostics.png)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Diagnostics.png)
+[![The system debug menu showing how to enable the NTP diagnostics](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/3/2/1/0/NTP_Diagnostics.png)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Diagnostics.png)
 
-**System Debug Menu - NTP Diagnostics (Click for a closer look)**
+*System Debug Menu - NTP Diagnostics (Click for a closer look)*
 
 ![The logging menu showing how to log the NTP requests](https://cdn.sparkfun.com/r/600-600/assets/learn_tutorials/3/2/1/0/NTP_Logging.png)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Logging.png)
 
-**Logging Menu - Log NTP Requests**
+*Logging Menu - Log NTP Requests*
 
-![NTP requests log](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Log.png)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Log.png)
+[![NTP requests log](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Log.png)](https://cdn.sparkfun.com/assets/learn_tutorials/3/2/1/0/NTP_Log.png)
 
-**Logged NTP Requests**
+*Logged NTP Requests*
 
 NTP uses its own epoch - midnight January 1st 1900. This is different to the standard Unix epoch - midnight January 1st 1970 - and the GPS epoch - midnight January 6th 1980. The times shown in the log and diagnostic messages use the NTP epoch. You can use online calculators to convert between the different epochs:
 
diff --git a/docs/repair.md b/docs/repair.md
@@ -194,11 +194,11 @@ Taking the Reference Station apart is really easy:
 * Disconnect all cables
 
 * Unplug the green 10-way 3.5mm I/O connector
-  * This makes it easy to remove the main PCB from the enclosure
-  * The connector is a firm fit. You may need to rock it from side to side as you unplug it
+    * This makes it easy to remove the main PCB from the enclosure
+    * The connector is a firm fit. You may need to rock it from side to side as you unplug it
   
 * Unscrew the four screws holding the front panel in place
-  * We recommend removing the front panel first, so you can unplug the OLED display
+    * We recommend removing the front panel first, so you can unplug the OLED display
   
 * Remove the front panel
 

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,6 @@ Enable 'Sensor Fusion' to begin using the onboard IMU when GNSS is avaialble. Se`
`14`	`14`
`15`	`15`	`'Automatic IMU-Mount Alignment' will allow the device to automatically determine how the product is mounted within the vehicle's frame of reference.`
`16`	`16`
`17`		`-Additionally, wheel ticks should be provided to the unit to enhance the positional fixes. Please see [Mux Channel](https://docs.sparkfun.com/SparkFun_RTK_Firmware/configure_ports/#mux-channel) of the Ports Menu for more information.`
	`17`	`+Additionally, wheel ticks should be provided to the unit to enhance the positional fixes. Please see [Mux Channel](configure_ports.md/#mux-channel) of the Ports Menu for more information.`
`18`	`18`
`19`	`19`