Skip to content

Commit 43c334a

Browse files
santaimpersonatorsantaimpersonator
committed
Add homepage redirect
Allow for users to name the homepage file as introduction.md because the index.md redirects to it (simplifies file names for maintenance) - Renamed (original) index.md to introduction.md - Added (new) index.md as place holder for redirect functionality
1 parent 964f144 commit 43c334a

File tree

3 files changed

+46
-40
lines changed

3 files changed

+46
-40
lines changed

‎docs/index.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1 @@
1-
# Introduction
2-
3-
The SparkFun RTK Everywhere products are exceptional GNSS receivers out-of-box and can be used with little or no configuration. This RTK Everywhere Product Manual provides detailed descriptions of all the available features of the RTK products.
4-
5-
The line of RTK Everywhere products offered by SparkFun all run identical firmware. The [RTK Everywhere firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) and this guide cover the following products:
6-
7-
<table class="table table-hover table-striped table-bordered">
8-
<tr align="center">
9-
<td><a href="https://www.sparkfun.com/products/25662"><img src="img/SparkFun_RTK_Torch.png"></a></td>
10-
<td><a href="https://www.sparkfun.com/products/24342"><img src="img/SparkFun_RTK_EVK.png"></a></td>
11-
</tr>
12-
<tr align="center">
13-
<td><a href="https://www.sparkfun.com/products/25662">SparkFun RTK Torch (GPS-25662)</a></td>
14-
<td><a href="https://www.sparkfun.com/products/24342">SparkFun RTK EVK (GPS-24342)</a></td>
15-
</tr>
16-
<tr align="center">
17-
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
18-
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
19-
</tr>
20-
</table>
21-
22-
Depending on the hardware platform different features may or may not be supported. We will denote each product in each section so that you know what is supported.
23-
24-
There are multiple ways to configure an RTK product:
25-
26-
* [Bluetooth](configure_with_bluetooth.md) - Good for in-field changes
27-
* [WiFi](configure_with_wifi.md) - Good for in-field changes
28-
* [Serial Terminal](configure_with_serial.md) - Requires a computer but allows for all configuration settings
29-
* [Settings File](configure_with_settings_file.md) - Used for configuring multiple RTK devices identically
30-
* [Ethernet](configure_with_ethernet.md) - RTK EVK only
31-
32-
The Bluetooth or Serial Terminal methods are recommended for most advanced configurations. Most, but not all settings are also available over WiFi but can be tricky to input via mobile phone.
33-
34-
If you have an issue, feature request, bug report, or a general question about the RTK firmware specifically we encourage you to post your comments on the [firmware's repository](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues). If you feel like bragging or showing off what you did with your RTK product, we'd be thrilled to hear about it on the issues list as well!
35-
36-
Things like how to attach an antenna or other hardware-specific topics are best read on the Hookup Guides for the individual products.
1+
This is just a placeholder file for the webpage re-direct. All the content for this section is actually in the `introduction.md` file.

‎docs/introduction.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Introduction
2+
3+
The SparkFun RTK Everywhere products are exceptional GNSS receivers out-of-box and can be used with little or no configuration. This RTK Everywhere Product Manual provides detailed descriptions of all the available features of the RTK products.
4+
5+
The line of RTK Everywhere products offered by SparkFun all run identical firmware. The [RTK Everywhere firmware](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware) and this guide cover the following products:
6+
7+
<table class="table table-hover table-striped table-bordered">
8+
<tr align="center">
9+
<td><a href="https://www.sparkfun.com/products/25662"><img src="img/SparkFun_RTK_Torch.png"></a></td>
10+
<td><a href="https://www.sparkfun.com/products/24342"><img src="img/SparkFun_RTK_EVK.png"></a></td>
11+
</tr>
12+
<tr align="center">
13+
<td><a href="https://www.sparkfun.com/products/25662">SparkFun RTK Torch (GPS-25662)</a></td>
14+
<td><a href="https://www.sparkfun.com/products/24342">SparkFun RTK EVK (GPS-24342)</a></td>
15+
</tr>
16+
<tr align="center">
17+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_Torch/">Hookup Guide</a></td>
18+
<td><a href="https://docs.sparkfun.com/SparkFun_RTK_EVK/">Hookup Guide</a></td>
19+
</tr>
20+
</table>
21+
22+
23+
Depending on the hardware platform different features may or may not be supported. We will denote each product in each section so that you know what is supported.
24+
25+
There are multiple ways to configure an RTK product:
26+
27+
* [Bluetooth](configure_with_bluetooth.md) - Good for in-field changes
28+
* [WiFi](configure_with_wifi.md) - Good for in-field changes
29+
* [Serial Terminal](configure_with_serial.md) - Requires a computer but allows for all configuration settings
30+
* [Settings File](configure_with_settings_file.md) - Used for configuring multiple RTK devices identically
31+
* [Ethernet](configure_with_ethernet.md) - RTK EVK only
32+
33+
The Bluetooth or Serial Terminal methods are recommended for most advanced configurations. Most, but not all settings are also available over WiFi but can be tricky to input via mobile phone.
34+
35+
If you have an issue, feature request, bug report, or a general question about the RTK firmware specifically we encourage you to post your comments on the [firmware's repository](https://github.com/sparkfun/SparkFun_RTK_Everywhere_Firmware/issues). If you feel like bragging or showing off what you did with your RTK product, we'd be thrilled to hear about it on the issues list as well!
36+
37+
Things like how to attach an antenna or other hardware-specific topics are best read on the Hookup Guides for the individual products.

‎mkdocs.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,9 +153,9 @@ plugins:
153153
- typeset
154154

155155
# Redirects page navigation
156-
# - redirects:
157-
# redirect_maps:
158-
# 'index.md': 'introduction.md'
156+
- redirects:
157+
redirect_maps:
158+
'index.md': 'introduction.md'
159159

160160
# Enables improved security for external links
161161
- privacy:
@@ -395,9 +395,13 @@ extra_javascript:
395395
exclude_docs: |
396396
README.md
397397
398+
# Pages that are built, but not in the navigation menu
399+
not_in_nav: |
400+
index.md
401+
398402
# Webpage navigation menu
399403
nav:
400-
- Introduction: index.md
404+
- Introduction: introduction.md
401405
- Quick Start:
402406
- quickstart-torch.md
403407
- quickstart-evk.md

0 commit comments

Comments
 (0)