diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index b93bada..755ca8f 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -43,6 +43,7 @@ export default defineConfig({ { text: 'Home', link: '/' }, { text: 'Getting Started', link: '/getting-started' }, { text: 'Block List', link: '/block-index' }, + { text: 'Contributing', link: '/contributing' }, // { text: 'Examples', link: '/automation-examples' } ], diff --git a/docs/block-index.md b/docs/block-index.md index 803c442..35578b1 100644 --- a/docs/block-index.md +++ b/docs/block-index.md @@ -1,7 +1,7 @@ --- -title: The Blocks +title: Block List --- -# The Blocks +# Block List Coming soon... diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..95af51d --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,41 @@ +--- +title: Contributing +--- + +# Contributing + +## Documentation Wrong or Missing? + +_You can help!_ + +### Have a GitHub Account? + +Awesome! You can suggest changes to any page in a few simple steps: +1. Scroll to the bottom of the page in question. +2. Click the _"Edit this page"_ link. +3. You will be asked to create a Fork, do so. +4. You should now see the page source, opened and editable. +5. Search for the text you'd like to change. +6. Make the desired changes. +7. Click the green _"Commit Changes..."_ button. (top-right) +8. Add a brief explanation about the purpose of your changes. +9. Click the green _"Propose Changes"_ button. +10. Congrats! You've just gotten involved improving things for everyone. + +### No GitHub Account? + +If you don't already have a GitHub account, but you're willing to create one, +simply head over to the [GitHub signup page](https://github.com/signup) and +do so. Once created, return to the instructions above. + +If you'd rather not create a GitHub account, no worries! You can suggest any +changes via [the Adafruit IO Forums](https://forums.adafruit.com/viewforum.php?f=56) +or [support channels](https://io.adafruit.com/support). + +## Want to Suggest a New Block? + +We'd love to hear from you! + +You can suggest new or updated blocks via +[the Adafruit IO Forums](https://forums.adafruit.com/viewforum.php?f=56) or +[support channels](https://io.adafruit.com/support).