Skip to content

Commit 92a3172

Browse files
bboyhobboyho
committed
Update Tutorial Based on Template
1 parent 0d28732 commit 92a3172

24 files changed

+2501
-306
lines changed

‎.github/workflows/mkdocs.yml

+22-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,33 @@
1-
# Used to run mkdocs on the repo
2-
3-
name: Documentation
1+
name: Run mkdocs
42
on:
53
push:
64
branches:
75
- main
6+
permissions:
7+
contents: write
88
jobs:
99
deploy:
1010
runs-on: ubuntu-latest
1111
steps:
12-
- uses: actions/checkout@v2
13-
- uses: actions/setup-python@v2
12+
- name: Checkout repository
13+
uses: actions/checkout@v3
14+
15+
- name: Set up Python runtime
16+
uses: actions/setup-python@v4
1417
with:
1518
python-version: 3.x
16-
- run: pip install mkdocs-material mkdocs-monorepo-plugin
19+
20+
- name: Install Python dependencies
21+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 setuptools
22+
23+
- name: Set up build cache
24+
uses: actions/cache@v2
25+
with:
26+
key: ${{ github.ref }}
27+
path: .cache
28+
29+
- name: Install Insiders build
30+
env:
31+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
32+
run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
1733
- run: mkdocs gh-deploy --force

‎docs/assets/MicroMod-logo-updated.png

25.7 KB
Loading

‎docs/assets/Qwiic-registered-updated.png

59 KB
Loading

‎docs/assets/sfe_favicon.png

14.5 KB
Loading

‎docs/github/contribute.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contribute: Help Fix our Mistake!
2+
Spot something wrong? Feel free to contribute our open-source design and documentation. <a href="https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library.svg" /></a>
3+
4+
## Improve our Documentation
5+
All of this documentation can be modified by you! Please help us make it better.
6+
7+
* These pages are contained in the [`docs` folder of the SparkFun Qwiic OLED Arduino Library repository](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/tree/main/docs).
8+
9+
### Submit a Correction
10+
1. Fork this repo
11+
2. Add your corrections or improvements to the markdown file
12+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
13+
* Once received, the documentation specialist will automatically be notified.
14+
* We will review your suggested improvements to make sure they are correct and fit within our documentation standards.
15+
16+
## Improve our Hardware Design
17+
All of our designs are open-source! Please help us make it better.
18+
19+
* Our board design files are contained in the `Hardware` folder of their respective repositories:
20+
21+
* [SparkFun Micro OLED Breakout (Qwiic)](https://github.com/sparkfun/Qwiic_Micro_OLED/tree/main/Hardware)
22+
* [SparkFun Qwiic OLED Display (0.91 in, 128x32)](https://github.com/sparkfun/SparkFun_Qwiic_OLED-0.91/tree/main/Hardware)
23+
* [SparkFun Transparent Graphical OLED Breakout (Qwiic)](https://github.com/sparkfun/Qwiic_Transparent_Graphical_OLED/tree/main/Hardware)
24+
* [SparkFun Qwiic OLED - (1.3in., 128x64)](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/tree/main/Hardware)
25+
26+
### Submit a Design Improvement
27+
1. Fork this repo
28+
2. Add your design improvements
29+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
30+
* Once received, the engineer in charge of the original design will automatically be notified.
31+
* 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.)*
32+
33+
## Contributors
34+
Let's provided some recognition to the contributors for this project!
35+
36+
![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/)
37+
<br>
38+
<a href="https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library.svg" /></a>

‎docs/github/file_issue.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Did we make a mistake?
2+
3+
Spot something wrong? Please let us know. <a href="https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/issues" alt="Issues"><img src="https://img.shields.io/github/issues/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library.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 Qwiic OLED Arduino Library repository](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/tree/main/docs).
18+
19+
### Spot something wrong?
20+
If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/issues) and let us know.
21+
22+
### Do you have a suggested correction?
23+
1. With a GitHub account, fork this repo
24+
2. Add your correction(s) or improvement(s) to the markdown file(s)
25+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
26+
* Once received, the documentation specialist will automatically be notified.
27+
* We will review your suggested improvement(s) to make sure they are correct and fit within our documentation standards.
28+
29+
## Problems in the Hardware Design
30+
31+
All of our designs are open-source! Please help us make it better.
32+
33+
Our board design files are contained in the `Hardware` folder of their respective repositories:
34+
35+
* [SparkFun Micro OLED Breakout (Qwiic)](https://github.com/sparkfun/Qwiic_Micro_OLED/tree/main/Hardware)
36+
* [SparkFun Qwiic OLED Display (0.91 in, 128x32)](https://github.com/sparkfun/SparkFun_Qwiic_OLED-0.91/tree/main/Hardware)
37+
* [SparkFun Transparent Graphical OLED Breakout (Qwiic)](https://github.com/sparkfun/Qwiic_Transparent_Graphical_OLED/tree/main/Hardware)
38+
* [SparkFun Qwiic OLED - (1.3in., 128x64)](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/tree/main/Hardware)
39+
40+
### Does something not make sense?
41+
If part of the design is confusing, please [open an issue](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/issues) and let us know.
42+
43+
### Did we forget to include an important function of the board?
44+
* 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.)*
45+
* If part of the board's functionality is missing, please [open an issue](https://github.com/sparkfun/SparkFun_Qwiic_OLED_Arduino_Library/issues) and file a feature request.
46+
47+
### Do you wish to contribute directly to improving the board design?
48+
1. With a GitHub account, Fork this repo
49+
2. Add your design improvement(s)
50+
3. File a pull request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
51+
* Once received, the engineer in charge of the original design will automatically be notified.
52+
* 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.)*

‎docs/hug_1in3.md renamed to ‎docs/hug_1p3.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
# Qwiic OLED 1.3in Setup
2-
31
The Qwiic OLED 1.3in has its own [hook-up guide](https://docs.sparkfun.com/SparkFun_Qwiic_OLED_1.3in/).

0 commit comments

Comments
 (0)