-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding code snippets, stylesheet & contribute/file issue files.
- Loading branch information
Showing
5 changed files
with
622 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Help Improve the Experience! | ||
Spot an improvement opportunity? Feel free to contribute to our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Thing_Plus_ESP32-S3.svg" /></a> | ||
|
||
## Enhance 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](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/docs) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository. | ||
|
||
### 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. | ||
|
||
## Upgrade 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](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/Hardware) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository. | ||
|
||
### Submit a Design Improvement | ||
1. Fork this repo | ||
2. Add your design modifications | ||
3. File a pull request with your changes, and enjoy making the world a better place. | ||
* Once received, the engineer in charge of the original design will automatically be notified. | ||
* We will review your suggested upgrades, if they are within our board design standards and meet our product design requirements, we will flag these changes for our next board revision. | ||
|
||
!!! note | ||
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 provide some recognition to those who have contributed to this project! | ||
|
||
![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_Thing_Plus_ESP32-S3) | ||
<br> | ||
<a href="https://github.com/sparkfun/SparkFun_Qwiic_CO2_Sensor_SCD4X/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Thing_Plus_ESP32-S3.svg" /></a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Did we make a mistake? | ||
|
||
Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Thing_Plus_ESP32-S3.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, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search product forums and ask questions. | ||
|
||
!!! info "Account Registration Required" | ||
If this is your first visit to our forum, you'll need to create 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](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/docs) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository. | ||
|
||
### Spot something wrong? | ||
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/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](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/tree/main/Hardware) of the [SparkFun Thing Plus - ESP32-S3](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3) repository. | ||
|
||
### Does something not make sense? | ||
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Thing_Plus_ESP32-S3/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_Thing_Plus_ESP32-S3/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.)* |
Oops, something went wrong.