SteemDocs.net - Glossary Bundle #1 - Utopian Powered Steem Documation Network Website

in utopian-io •  last year  (edited)

sdnherobg.png

Repository

https://github.com/steemdocs/steemdocs

Details

Steemdocs is a project that aims to build the equivalent of MDN for the Steem blockchain. One task that is important as a basis for the whole website is a glossary of terms. Those terms will then be used throughout the website in tutorials, documentation, references, etc.

Steemdocs is fully open-sourced and powered by @utopian-io.

Glossary

We are trying to explain in as few words as possible the terms that are commonly used when developing on the network. If you want to contribute to the glossary, read the Glossary Contribution Guidelines. We will be happy to consider your pull requests!

This is the first "bundle" of words that was introduced through this pull request:

  • STEEM (the token)
  • Steem (the blockchain)
  • Steem Backed Dollars
  • Steem Power
  • VESTS

Our criteria for using Utopian for this pull request on the document is "would these articles, taken as a whole, provide enough value to developers in a way that would impact their work, and would otherwise not be possible with what's currently available out there?"

We've scoured the internet for such a thing and we haven't found what we are looking for, this glossary is the first of its type. This content is targeted for developers primarily.

We had to parse through the whitepaper and the bluepaper as well as multiple articles in order to compile that content in a way that is easy to understand.

GitHub Proof of Authorship

GitHub Account: https://github.com/RenaudGagne
Pull Request: https://github.com/steemdocs/steemdocs/pull/1

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

Hello @cryptooctopus,

So I am really excited to see a contribution in the category and as I can see this project will have more upcoming contributions.

Though the documentation part was complete which has resulted in a high score of the contribution the formatting of the post can be improved a bit.

Another thing which could have made this contribution a staff pick is a bit more amount of work put into the contribution(which means adding more data in one PR or adding more PRs in a single contribution :D).

One thing I would like to see or ask is that there is a lot of data already present in FAQ of stinc though it is not properly maintained so I would like to see the project evolve to have better and maintained information then it.

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

Thank you for your review, @ms10398!

So far this week you've reviewed 1 contributions. Keep up the good work!

Thank you @ms10398. Each of those bundle account for a few hours of works since I have to constantly go back and forth, update links, find better ways to say things, etc. In the coming weeks, I'll try to add more to each of those contributions...but I basically made it so that each "bundle" account for a day of work.

We are not looking to provide information to Steemit users like the FAQ does. We are really aiming to be the one stop shop for developers. So the wording and the content will differ widely from what can be found on the wiki or the Steemit.com website.

I'm curious by what you mean by "formating" improvement.

Again, thanks for reviewing the work!

Hey there

While I see a lot of potential in the project if it is done right but it needs some dedicated time for it

It can become one stop for all steem devs and people joining steem.

I wish you good luck for the project.

For the formatting part I would say you can include some content structure or some part of documentation in the post which will give some length to the post otherwise it looks too short sometimes on terms of content

Though it's the least weighted point for me while I review a post as the real work done is on GitHub or in official documentation but it has minor points in review process

But I can say I still pick staff pick post which are decent and not great in terms of length or formatting as I appreciate the work which is done on GitHub or Documentation so I would say adding little more amount of work in the PR can result in the next contribution a worthy contribution to be a staff pick.

Another thing I saw that there were three empty lines in doc files on GitHub I would comment on GitHub too about it

As there should be only one empty line at end of file so can you take care of that

Thank you for the upvote and waiting for the next contribution.

As someone who is currently trying to learn how to code... and constantly gets held up by old tutorials that assume certain key bits of knowledge, this is going to be absolutely crucial to me and all the people that follow... thank you so much for putting this together!

Im really glad to hear that. We are looking forward to create the gold standard :-)

I do not know much programming 😟but if I wanted to learn 🙂 and really I admire the people that if they do it 😍 and makes everything look so easy, the developers do an incredible job so that everything is fine, thanks for all the work you do.

Hi @cryptoctopus!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

Hey, @cryptoctopus!

Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!