From bcd2b794acfd53216fb036150b14dffdbc480bb4 Mon Sep 17 00:00:00 2001 From: Paul Date: Thu, 1 Sep 2022 11:41:11 +0100 Subject: [PATCH] Docs updates --- .github/workflows/compile-sketch.yml | 5 ++--- .github/workflows/mkdocs.yml | 3 ++- README.md | 4 ++++ docs/contribute.md | 29 ++++++++++++++++++++++++++++ docs/index.md | 8 ++++++-- mkdocs.yml | 8 +++++++- 6 files changed, 50 insertions(+), 7 deletions(-) create mode 100644 docs/contribute.md diff --git a/.github/workflows/compile-sketch.yml b/.github/workflows/compile-sketch.yml index c7d175e..5771685 100644 --- a/.github/workflows/compile-sketch.yml +++ b/.github/workflows/compile-sketch.yml @@ -1,9 +1,8 @@ name: Compile Sketch on: - # - push - - pull_request - + pull_request: + workflow_dispatch: jobs: compile-sketch: diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml index be9de37..9b461dd 100644 --- a/.github/workflows/mkdocs.yml +++ b/.github/workflows/mkdocs.yml @@ -1,6 +1,6 @@ # Used to run mkdocs on the repo -name: ci +name: mkdocs on: push: branches: @@ -8,6 +8,7 @@ on: pull_request: branches: - main + workflow_dispatch: jobs: deploy: runs-on: ubuntu-latest diff --git a/README.md b/README.md index b48f90a..e91a978 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@

+ + + + diff --git a/docs/contribute.md b/docs/contribute.md new file mode 100644 index 0000000..c256b54 --- /dev/null +++ b/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. + +## 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) +
+ \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index b41db9a..c2a11dd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,11 +3,15 @@

+ + + + - follow on Twitter + follow on Twitter

diff --git a/mkdocs.yml b/mkdocs.yml index 28821db..446d276 100644 --- a/mkdocs.yml +++ b/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' - \ No newline at end of file + - Contribution/Issues: + - Contribute: contribute.md + \ No newline at end of file