|
| 1 | +# Did we make a mistake? |
| 2 | + |
| 3 | +Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Pro_Micro_RP2350.svg" /></a> |
| 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_Pro_Micro_RP2350/tree/main/docs) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350). |
| 24 | + |
| 25 | +### 🔍 Spot something wrong? |
| 26 | + |
| 27 | +If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/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_Pro_Micro_RP2350/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 | +## Problems in the Hardware Design |
| 38 | + |
| 39 | +All of our designs are open-source! Please help us make it better. |
| 40 | + |
| 41 | +* Our board design files are contained in the [`Hardware` folder](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/tree/main/Hardware) of the [<Official Product Name> repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350). |
| 42 | + |
| 43 | +### Does something not make sense? 🤔 |
| 44 | + |
| 45 | +If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and let us know. |
| 46 | + |
| 47 | +### Did we forget to include an important function of the board? 🤦 |
| 48 | + |
| 49 | +If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/issues) and file a feature request. |
| 50 | + |
| 51 | +!!! tip "Design Considerations" |
| 52 | + Please keep in mind that we may intentionally exclude certain functions of the board to meet our product design requirements. |
| 53 | + |
| 54 | + * *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.* |
| 55 | + |
| 56 | + |
| 57 | +### Do you wish to contribute directly to improving the board design? |
| 58 | + |
| 59 | +1. With a GitHub account, [fork this repository](https://github.com/sparkfun/SparkFun_Pro_Micro_RP2350/fork). |
| 60 | +2. Add your design augmentation(s) |
| 61 | +3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place. |
| 62 | + 1. Once received, the engineer in charge of the original design will automatically be notified. |
| 63 | + 2. We will review your suggested improvement(s) to verify that they are within our board design standards and meet our product design requirements. |
| 64 | + 3. If approved, we will flag these changes for our next board revision. Congrats! 🍻 |
| 65 | + |
| 66 | + !!! info |
| 67 | + Even if your suggestion is accepted, these changes may not be immediately available for purchase. We may have to cycle through our current product inventory first. |
0 commit comments