Skip to content

Commit c45ae04

Browse files
committed
Update docs
1 parent 261b688 commit c45ae04

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

docs/contribute.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Fix That Typo!
2+
3+
See a typo?
4+
5+
All of this documentation can be modified by you! Please help us make it better.
6+
7+
Does something not make sense? If a section is confusing please open an issue and let us know.
8+
9+
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.

docs/firmware_intro.md renamed to docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
Out of the box, the SparkFun RTK products are exceptional GNSS receivers out-of-box and can be used with little or no configuration. This tutorial is for advanced setups and for users looking to learn every knob that can be turned.
3+
Out of the box, the SparkFun RTK products are exceptional GNSS receivers out-of-box and can be used with little or no configuration. This RTK Product Manual provides detailed descriptions of all the available features on the RTK products.
44

55
The line of RTK products offered by SparkFun all run identical firmware. The [RTK firmware](https://github.com/sparkfun/SparkFun_RTK_Firmware) and this guide cover the following products:
66

docs/system_status_report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Sending the `~` character to the device over the serial port will trigger a syst
88

99
*Terminal showing System Status*
1010

11+
Below is an example system status report sentence:
12+
1113
> $GNTXT,01,01,05,202447.00,270522,0.380,29,40.090355193,-105.184764700,1560.56,3,0,86*71
1214
1315
* $GNTXT : Start of custom NMEA sentence

mkdocs.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ extra:
7373
link: https://twitter.com/sparkfun
7474

7575
nav:
76-
- RTK Firmware:
77-
- firmware_intro.md
76+
- Software Specifics:
77+
- intro.md
7878
- displays.md
7979
- system_configuration.md
8080
- configure_with_wifi.md
@@ -91,9 +91,12 @@ nav:
9191
- menu_system_status.md
9292
- system_status_report.md
9393
- firmware_update.md
94+
- contribute.md
9495
- Hardware Specifics:
9596
- hardware_rtk_surveyor.md
9697
- hardware_rtk_express.md
9798
- hardware_rtk_express_plus.md
9899
- hardware_rtk_facet.md
100+
- contribute.md
101+
99102

0 commit comments

Comments
 (0)