Skip to content

Commit 7f83d3c

Browse files
committed
copy in documentation support template/files ...
1 parent 9c2e356 commit 7f83d3c

18 files changed

+1099
-0
lines changed

docs/assets/sfe_favicon.png

14.5 KB
Loading

docs/assets/sfe_logo_sm.png

5.41 KB
Loading

docs/github/contribute.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contribute: Help Fix our Mistake
2+
3+
Spot something wrong? Feel free to contribute our open-source design and documentation. <a href="https://github.com/sparkfun/sfe-iot-node-lorawan/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/sfe-iot-node-lorawan.svg" /></a>
4+
5+
## Improve our Documentation
6+
7+
All of this documentation can be modified by you! Please help us make it better.
8+
9+
* These pages are contained in the [`docs` folder of the SparkFun IoT Node - LoRaWAN firmware repository](https://github.com/sparkfun/sfe-iot-node-lorawan/tree/main/docs).
10+
11+
### Submit a Correction
12+
13+
1. Fork this repo
14+
2. Add your corrections or improvements to the markdown file
15+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
16+
* Once received, the documentation specialist will automatically be notified.
17+
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.
18+
19+
## Improve our Hardware Design
20+
21+
All of our designs are open-source! Please help us make it better.
22+
23+
* Our board design files are contained in the [`Hardware` folder of the SparkFun IoT Node - LoRaWAN repository](https://github.com/sparkfun/sfe-iot-node-lorawan/tree/main/Hardware).

docs/github/file_issue.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Did we make a mistake?
2+
3+
Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/sfe-iot-node-lorawan/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/sfe-iot-node-lorawan.svg" /></a>
4+
5+
!!! attention
6+
This is not where customers should seek assistance on a product. If you require technical assistance or have questions about a product that is not working as expected, please head over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistance) page for some initial troubleshooting.
7+
<center>
8+
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
9+
</center>
10+
11+
If you can't find what you need there, you'll need a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to search product forums and post questions.
12+
13+
## Discrepancies in the Documentation
14+
15+
All of this documentation can be modified by you! Please help us make it better.
16+
17+
* The documentation files for these pages are contained in the [`docs` folder of the SparkFun IoT Node - LoRaWAN repository](https://github.com/sparkfun/sfe-iot-node-lorawan/tree/main/docs).
18+
19+
### Spot something wrong?
20+
21+
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/sfe-iot-node-lorawan/issues) and let us know.
22+
23+
### Do you have a suggested correction?
24+
25+
1. With a GitHub account, fork this repo
26+
2. Add your correction(s) or improvement(s) to the markdown file(s)
27+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
28+
* Once received, the documentation specialist will automatically be notified.
29+
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.

docs/hard_copy.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
icon: material/book-open-variant
3+
---
4+
5+
Need to download or print our hookup guide?
6+
7+
* [Print :fontawesome-solid-print:](../single_page) (Single-Page View)
8+
* To save as a `*.pdf` file, select the **Printer** or **Destination** labeled ++"Save as PDF"++. *(Instructions will vary based on the browser)*
9+
<!-- * [Download :fontawesome-regular-file-pdf:](../hookup_guide.pdf) *(Beta - demonstration only)* -->

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Placeholder file for index redirect functionality.

docs/introduction.md

Whitespace-only changes.

docs/javascript/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
javascript directory
2+
====================
3+
This folder should contain the files for the custom javascript that is enabled in the product documentation

docs/javascript/mathjax.js

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
window.MathJax = {
2+
tex: {
3+
inlineMath: [["\\(", "\\)"]],
4+
displayMath: [["\\[", "\\]"]],
5+
processEscapes: true,
6+
processEnvironments: true,
7+
// No Equation Numbering
8+
tags: 'none'
9+
},
10+
options: {
11+
ignoreHtmlClass: ".*|",
12+
processHtmlClass: "arithmatex"
13+
}
14+
};
15+
16+
document$.subscribe(() => {
17+
MathJax.typesetPromise()
18+
})
19+

docs/single_page.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
icon: fontawesome/solid/scroll
6+
---
7+
8+
# Introduction
9+
--8<-- "./docs/introduction.md"
10+
11+
# Hardware Overview
12+
--8<-- "./docs/hardware_overview.md"
13+
14+
# Hardware Hookup
15+
--8<-- "./docs/hardware_hookup.md"
16+
17+
# Arduino Example
18+
--8<-- "./docs/arduino_example.md"
19+
20+
# Troubleshooting
21+
--8<-- "./docs/troubleshooting.md"
22+
23+
# Resources
24+
--8<-- "./docs/resources.md"

0 commit comments

Comments
 (0)