Skip to content

Commit 3bdd3ef

Browse files
committed
cleanup and simplify docs
1 parent e7a036b commit 3bdd3ef

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

docs/contribute.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
1-
# Contribute: Help Fix our Mistake!
2-
Spot something wrong? Feel free to contribute our documentation. <a href="https://github.com/sparkfun/SparkFun_DataLogger/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_DataLogger.svg" /></a>
1+
---
2+
icon: material/package-variant-closed-plus
3+
---
4+
5+
6+
# Contribute
37

48
## Improve our Documentation
9+
510
All of this documentation can be modified by you! Please help us make it better.
611

712
* These pages are contained in the [`docs` folder of the SparkFun DataLogger IoT repository](https://github.com/sparkfun/SparkFun_DataLogger/tree/main/docs).
813

914
### Submit a Correction
15+
1016
1. Fork this repo
1117
2. Add your corrections or improvements to the markdown file
1218
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
1319
* Once received, the documentation specialist will automatically be notified.
1420
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.
1521

1622
## Improve our Hardware Design
23+
1724
This hardware design is open-source! Please help us make it better.
1825

1926
* Our board design files are contained in the [`Hardware` folder of the SparkFun DataLogger IoT repository](https://github.com/sparkfun/SparkFun_DataLogger_IoT_9DoF/tree/main/Hardware).
2027

2128
### Submit a Design Improvement
29+
2230
1. Fork this repo
2331
2. Add your design improvements
2432
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
2533
* Once received, the engineer in charge of the original design will automatically be notified.
2634
* We will review your suggested improvements, if they are within our board design standards and meet our product design requirements, we will flag these changes for our next board revision. *(Please note, that even if your suggestion is accepted, these changes may not be immediate. We may have to cycle through our current product inventory first.)*
2735

2836
## Contributors
37+
2938
Let's provided some recognition to the contributors for this project!
3039

31-
![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_DataLogger)
32-
<br>
33-
<a href="https://github.com/sparkfun/SparkFun_DataLogger/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_DataLogger.svg" /></a>
40+
[GitHub Contributors Image](https://img.shields.io/github/contributors/sparkfun/SparkFun_DataLogger.svg)

0 commit comments

Comments
 (0)