Merge pull request #16 from sparkfun/release_candidate

Docs updates

Author: PaulZC

.github/workflows/compile-sketch.yml

@@ -1,9 +1,8 @@
 name: Compile Sketch
 
 on:
-  # - push
-  - pull_request
-
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   compile-sketch:

.github/workflows/mkdocs.yml

@@ -1,13 +1,14 @@
 # Used to run mkdocs on the repo
 
-name: ci 
+name: mkdocs
 on:
   push:
     branches:
       - main
   pull_request:
     branches:
       - main
+  workflow_dispatch:
 jobs:
   deploy:
     runs-on: ubuntu-latest

README.md

@@ -3,6 +3,10 @@
 <p align="center">
     <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/issues" alt="Issues">
         <img src="https://img.shields.io/github/issues/sparkfun/SparkFun_ST25DV64KC_Arduino_Library.svg" /></a>
+    <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions" alt="Actions">
+        <img src="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions/workflows/mkdocs.yml/badge.svg" /></a>
+    <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions" alt="Actions">
+        <img src="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions/workflows/compile-sketch.yml/badge.svg" /></a>
     <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/blob/master/LICENSE" alt="License">
         <img src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
     <a href="https://twitter.com/intent/follow?screen_name=sparkfun">

docs/contribute.md

@@ -0,0 +1,29 @@
+# Contribute: Help Make This Library Better!
+
+Spot something wrong or which could be improved? Feel free to contribute our open-source software and documentation. <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/issues-pr/sparkfun/SparkFun_ST25DV64KC_Arduino_Library.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](https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/tree/main/docs) of the [SparkFun ST25DV64KC Arduino Library](https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library) repository.
+
+### Spot something wrong?
+
+If a section of the documentation is incorrect, please [open an issue](https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/issues) and let us know.
+
+### Submit a Correction or Improvement
+
+1. [Fork this repo](https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/fork)
+2. Add your corrections or improvements to the markdown file or source code
+3. File a Pull Request with your changes, and enjoy making the ~~words~~ ~~worlds~~ world a better place.
+    * Once received, the code and documentation specialist will automatically be notified.
+    * We will review your suggested improvements to make sure they are correct and fit within our standards.
+
+## Contributors
+
+Let's provided some recognition to the contributors for this project!
+
+![GitHub Contributors Image](https://contrib.rocks/image?repo=sparkfun/SparkFun_ST25DV64KC_Arduino_Library)
+<br>
+<a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/pulls" alt="Pull Requests"><img src="https://img.shields.io/github/contributors/sparkfun/SparkFun_ST25DV64KC_Arduino_Library.svg" /></a>

docs/index.md

@@ -3,11 +3,15 @@
 <p align="center">
     <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/issues" alt="Issues">
         <img src="https://img.shields.io/github/issues/sparkfun/SparkFun_ST25DV64KC_Arduino_Library.svg" /></a>
+    <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions" alt="Actions">
+        <img src="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions/workflows/mkdocs.yml/badge.svg" /></a>
+    <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions" alt="Actions">
+        <img src="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/actions/workflows/compile-sketch.yml/badge.svg" /></a>
     <a href="https://github.com/sparkfun/SparkFun_ST25DV64KC_Arduino_Library/blob/master/LICENSE" alt="License">
         <img src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
     <a href="https://twitter.com/intent/follow?screen_name=sparkfun">
-                    <img src="https://img.shields.io/twitter/follow/sparkfun.svg?style=social&logo=twitter"
-                          alt="follow on Twitter"></a>
+        <img src="https://img.shields.io/twitter/follow/sparkfun.svg?style=social&logo=twitter"
+        alt="follow on Twitter"></a>
 </p>
 
 <table class="table table-hover table-striped table-bordered">

mkdocs.yml

@@ -3,6 +3,8 @@ site_name: SparkFun ST25DV64KC Arduino Library - Documentation
 site_description: SparkFun ST25DV64KC Arduino Library. A library which makes it easy to read and write a ST25DV dynamic tag's EEPROM memory. It has built-in support for reading and writing NDEF URI, WiFi and Text records.
 site_url: https://sparkfun.github.io/SparkFun_ST25DV64KC_Arduino_Library/
 
+edit_uri: edit/main/docs/
+
 theme:
   name: material
   logo: img/sfe_logo_sm.png
@@ -57,6 +59,8 @@ markdown_extensions:
   - pymdownx.tilde
   - tables
   - admonition
+  - md_in_html
+  - attr_list
 
 extra:
   social:
@@ -81,4 +85,6 @@ nav:
     - SFE_ST25DV64KC_NDEF: api_SFE_ST25DV64KC_NDEF.md
     - SFE_ST25DV64KC_IO: api_SFE_ST25DV64KC_IO.md
   - Examples: '!include ./examples/mkdocs.yml'
-    
+  - Contribution/Issues:
+    - Contribute: contribute.md
+