Introduction
Few months ago, I introduced my long time friend @kareniel to the Steem blockchain. Being a seasoned dev, his first impression wasn't the best when it came to the documentation available and the way it was structured. We both want to see this blockchain succeed and having great resources for documentation is key to attracting devs to the ecosystem. So we decided to create the Steem Documentation Network.
Steemdocs.net is an open-source project powered by utopian.io that aims to create the best documentation website for everything related developing on the Steem blockchain. Think MDN(Mozilla Documentation Network) but for the Steem blockchain.
We don't aim to insult the work that is currently being done on the official developer portal but rather than get into a fight on how doc websites should be done, we decided to create an alternative.
We Are a Utopian Powered Open-Source Project
There is only so much two guys working part-time can accomplish. This project needs more contributors to become what it is meant to be.
How to get rewards for participating?
The process is simple:
- Create documentation
- Do a Pull Request
- Get Merged
- Submit your contribution to Utopian
Then if your contribution meets Utopian's standards you will get an upvote from @utopian-io and me.
1- Contribute to the Glossary
One way to participate is to contribute to the glossary of terms. This is core to developing a robust documentation and will be used throughout the tutorial and platform section of the website. If you are interested in contributing to it, make sure to look at other terms and follow the same template. Bundle 5 to 10 terms in your pull request for maximum rewards from Utopian. (Editing work is also highly valued!)
On our trello board, you can find the list of terms we are looking to add to the website
https://trello.com/c/7MnbNN8j/15-glossary-items
2- Contribute to "Platform"
We are building documentation on all the properties, primitives, methods, operations and plugins found on the Steem blockchain. This kind of work requires more in-depth knowledge of the development side of things.
Here is a good example of what we are looking for:
https://steemdocs.net/platform/operations/create_claimed_account.html
3- Create Tutorials
There is also a need for tutorials to explain how to do certain things such as:
- How to setup a testnet
- How to setup SteemConnect
- Etc.
To see our list of tutorial, check out our trello here:
https://trello.com/c/1zTxJhyW/99-list-of-tutorials
Conclusion
We hope that you'll be inspired to join us in this journey to build the Steem Documentation Network. The more of us contribute, the faster we'll be able to have a quality website that makes it as easy as possible for devs to get off to a good start when developing on the Steem Blockchain.
Photo by Fredrick Suwandi on Unsplash