SteemDocs.net Needs You!
.jpg)
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
Great project.
I have made a couple contributions and plan to contribute more in the future.
We shouldn’t expect everything from Steemit inc and this is a great example for the community from the community.
yes of course! Man it was really appreciated :-) Here is an humble upvote from us!
Thanks! :)
One thing i observed is that we think every day our life and on how to make things save and secure around us and our businesses. You guys really did a wonderful job i can imagine how much time consuming it was for you guys well done
@cryptoctopus and your team, I really highly appreciate your efforts for this inspiring project which is empowered by @utopian.io, "Steem Documentation Network" brought a great way for the development of Steem Blockchain. My support for it and hope for its rapid success.
I agree. The efforts put into this inspiring project is really amazing.
Why are there so many Steem ( steemit, steemdocs, steembr. Why do not you put all Steem together?
I think I agree with you that when it comes to documentation there seems to very little.
And the kind of project you have taken up will not only help current users in understanding Steemit better but it will help writers earn a bit of Steem for their efforts and give them a little exposure.
I will make sure to contribute soon. 😊
Are thesr only require a dev to perform or there is scope of others too....i am bit free nowadays so wondering if i can pitch in anyhow though i am not a dev
Posted using Partiko Android
the best place would be to contribute to the glossary
Glossary would be good...i checked trello too..with the list of words available....
As mentioned under the glosaary head.."check out on other terms and bundle 5 to 10" ...i did nt get about it...how to proceed with the contribution
Posted using Partiko Android
check out the current glossary terms, here is an example:
https://github.com/steemdocs/steemdocs/blob/master/docs/glossary/author.md
Then if you want to do a contribution, bundle your contribution is 5 to 10 glossary terms.
Very mu h doabel...and quite excited to make the contribution.
5 and 10 bundle means ...i need to make contribution of 5 words to 10 words. And these were contributed under documentation section of utopian...m right?
Posted using Partiko Android
Hola, podrias ayudarme y seguirme. Gracias
Absolutely needed, very good. I will pass this on to the other witnesses. :)
I'm just blown away by blockchain technology I'm going to have to set aside serious time to learn this steam documentation Network. thanks for sharing!
Great concept! Very much needed.
Muy interesante!