contributing page
This commit is contained in:
parent
46aec1da15
commit
848d9d5fda
3 changed files with 44 additions and 2 deletions
|
|
@ -43,6 +43,7 @@ export default defineConfig({
|
||||||
{ text: 'Home', link: '/' },
|
{ text: 'Home', link: '/' },
|
||||||
{ text: 'Getting Started', link: '/getting-started' },
|
{ text: 'Getting Started', link: '/getting-started' },
|
||||||
{ text: 'Block List', link: '/block-index' },
|
{ text: 'Block List', link: '/block-index' },
|
||||||
|
{ text: 'Contributing', link: '/contributing' },
|
||||||
// { text: 'Examples', link: '/automation-examples' }
|
// { text: 'Examples', link: '/automation-examples' }
|
||||||
],
|
],
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: The Blocks
|
title: Block List
|
||||||
---
|
---
|
||||||
|
|
||||||
# The Blocks
|
# Block List
|
||||||
|
|
||||||
Coming soon...
|
Coming soon...
|
||||||
|
|
|
||||||
41
docs/contributing.md
Normal file
41
docs/contributing.md
Normal file
|
|
@ -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).
|
||||||
Loading…
Reference in a new issue