Skip to content

Commit

Permalink
Initial Push GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
bboyho committed Jun 21, 2024
1 parent cd3aefd commit a40b672
Show file tree
Hide file tree
Showing 55 changed files with 1,824 additions and 117 deletions.
File renamed without changes.
Binary file added docs/assets/Qwiic-registered-updated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/24342-RTK-EVK-Feature.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/RTK_EVK_Enclosure_Dimensions.jpg
Binary file added docs/assets/sfe_favicon.png
Binary file added docs/assets/sfe_logo_sm.png
33 changes: 33 additions & 0 deletions docs/github/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contribute: Help Fix our Mistake!
Spot something wrong? Feel free to contribute our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_RTK_EVK/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_RTK_EVK.svg" /></a>

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

* These pages are contained in the [`docs` folder of the SparkFun RTK EVK repository](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/docs).

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

## Improve our Hardware Design
All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder of the SparkFunRTK EVK Repository](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Hardware).

### Submit a Design Improvement
1. Fork this repo
2. Add your design improvements
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the engineer in charge of the original design will automatically be notified.
* 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.)*

## Contributors
Let's provided some recognition to the contributors for this project!

![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_RTK_EVK/)
<br>
<a href="https://github.com/sparkfun/SparkFun_RTK_EVK/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_RTK_EVK.svg" /></a>
47 changes: 47 additions & 0 deletions docs/github/file_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Did we make a mistake?

Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_RTK_EVK/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_RTK_EVK.svg" /></a>

!!! attention
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.
<center>
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
</center>

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.

## Discrepancies in the Documentation

All of this documentation can be modified by you! Please help us make it better.

* The documentation files for these pages are contained in the [`docs` folder of the SparkFun RTK EVK repository](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/docs).

### Spot something wrong?
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_EVK/issues) and let us know.

### Do you have a suggested correction?
1. With a GitHub account, fork this repo
2. Add your correction(s) or improvement(s) to the markdown file(s)
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the documentation specialist will automatically be notified.
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.

## Problems in the Hardware Design

All of our designs are open-source! Please help us make it better.

* Our board design files are contained in the [`Hardware` folder of the SparkFun RTK EVK repository](https://github.com/sparkfun/SparkFun_RTK_EVK/tree/main/Hardware).

### Does something not make sense?
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_EVK/issues) and let us know.

### Did we forget to include an important function of the board?
* Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements. *(For example, our Qwiic Micro boards are intended to fit on a small board layout and only use I<sup>2</sup>C communication; therefore, we may not have the SPI and interrupt pins available for users.)*
* If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_RTK_EVK/issues) and file a feature request.

### Do you wish to contribute directly to improving the board design?
1. With a GitHub account, Fork this repo
2. Add your design improvement(s)
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
* Once received, the engineer in charge of the original design will automatically be notified.
* We will review your suggested improvement(s), 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.)*
9 changes: 9 additions & 0 deletions docs/hard_copy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
icon: material/book-open-variant
---

Need to download or print our hookup guide?

* [Print :fontawesome-solid-print:](../single_page) (Single-Page View)
* To save as a `*.pdf` file, select the **Printer** or **Destination** labeled ++"Save as PDF"++. *(Instructions will vary based on the browser)*
<!-- * [Download :fontawesome-regular-file-pdf:](../hookup_guide.pdf) *(Beta - demonstration only)* -->
Loading

0 comments on commit a40b672

Please sign in to comment.