Skip to content

Commit c05651d

Browse files
committed
Docs update
1 parent f7b1e0f commit c05651d

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

docs/contribute.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contribute: Make an Augmentation!
2+
Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. [![Pull Requests Badge](https://img.shields.io/github/issues-pr/sparkfun/SparkFun_RTK_Torch.svg)](https://github.com/sparkfun/SparkFun_RTK_Torch/pulls "Pull Requests")
3+
4+
## :material-file-document-multiple: Improve our Documentation
5+
All of this documentation can be modified by you! Please help us make it better.
6+
7+
* These pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_RTK_Torch/tree/main/docs) of the [SparkFun RTK Torch repository](https://github.com/sparkfun/SparkFun_RTK_Torch).
8+
9+
<!-- ### :material-source-pull:&nbsp;Submit a Correction -->
10+
### Submit a Correction
11+
12+
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_RTK_Torch/fork).
13+
2. Add your corrections or improvements to the markdown file.
14+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
15+
* Once received, the documentation specialist will automatically be notified.
16+
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.

docs/file_issue.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Did we make a mistake?
2+
3+
Spot something wrong? Please let us know. [![Open Issues Badge](https://img.shields.io/github/issues/sparkfun/SparkFun_RTK_Torch.svg)](https://github.com/sparkfun/SparkFun_RTK_Torch/issues "Issues")
4+
5+
<!-- Technical Assistance Box -->
6+
!!! warning "Need Help?"
7+
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistanc) page for some initial troubleshooting. This **Submit Issues** page is not where users should seek assistance.
8+
9+
<center>
10+
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
11+
</center>
12+
13+
If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search the product forums and ask questions.
14+
15+
!!! info "Account Registration Required"
16+
For your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to post questions.
17+
18+
19+
## Discrepancies in the Documentation
20+
21+
All of our documentation can be modified by you! Please help us make it better.
22+
23+
* The documentation files for these pages are contained in the [`docs` folder](https://github.com/sparkfun/SparkFun_RTK_Torch/tree/main/docs) of the [SparkFun RTK Torch](https://github.com/sparkfun/SparkFun_RTK_Torch).
24+
25+
### 🔍 Spot something wrong?
26+
27+
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_Torch/issues) and let us know.
28+
29+
### Do you have a suggested correction?
30+
31+
1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_RTK_Torch/fork).
32+
2. Add your correction(s) or improvement(s) to the markdown file(s)
33+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
34+
* Once received, the documentation specialist will automatically be notified.
35+
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.
36+
37+
### Does something not make sense? 🤔
38+
39+
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_Torch/issues) and let us know.
40+

0 commit comments

Comments
 (0)