SteemDocs.net - New platform section

in utopian-io •  last year  (edited)

Repository

https://github.com/steemdocs/steemdocs

Details

SteemDocs now has a new "platform" section, which is gonna house most of the technical documentation.

The tricky thing when you work on a project like this is that there needs to be a lot of information available for it to even be useful at all. This is why I decided to pick a topic to build documentation around. This way someone with a particular question would be able to find everything they need while they are working on a specific task.

I decided to pick the topic of subsidized account creation because that's a part of the platform I'm working with right now with @TokenBB, and hey, #HF20 was not even a month ago and this is a shiny new feature.

So here's a bit about what was involved in this update.

First, I had to identify which topics are involved in creating a subsidized account. Then I had to decide how to divide up the content for the platform section. This came through trial and error. I had to spend a good amount of time digging into the blockchain source code to identify relevant parts.

I then came up with a categorization scheme:

  1. Properties: These are variables or constants that are involved in different algorithms, like the fee required to create accounts, or the number of subsidized accounts that a user has claimed.
  2. Operations: These are actions that can be used to operate on the blockchain.
  3. Primitives: These are building blocks that often end up as parameters passed when broadcasting operations. They're subdivided into 'struct' and 'type', and usually refer to data structures that exist in the blockchain code.
  4. Plugins: These are the different modules of the system.
  5. Methods: Procedures that are exposed by some plugins, usually to get some kind of information about the underlying data.

Here's a list of the new topics that now have a page:

Properties:

  • available_account_subsidies
  • account_creation_fee
  • pending_claimed_accounts

Structs:

  • operation
  • transaction
  • authority
  • asset_type

Types:

  • account_name_type
  • extension_type
  • public_key_type
  • signature_type

Methods:

  • broadcast_transaction
  • claim_account
  • find_rc_accounts

Operations:

  • create_claimed_account_operation

Plugins:

  • Resource Credits Plugin

After writing the documentation and adding links between pages, I needed an index of the topics discussed. This would allow the user to understand at a glance how the platform section is organized and navigate to the item they are looking for.

So I wrote a basic Vue component (we're using Vuepress at the moment to build SteemDocs) that takes a list of topics and generates lists of links. The relevant code can be found here. It's nothing fancy but it's it gonna do the job for now!

Last but not least, I added a link to the new section in the navbar, otherwise you wouldn't be able to find the new content.

And that's it! We now have a section for technical documentation.

Links

https://steemdocs.net/platform/

GitHub Proof of Authorship

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:  

Thanks for the contribution, @kareniel! It's very cool what you guys are doing and definitely should be useful for a lot of developers on the Steem blockchain.

To me it seems like this contribution would be better suited to the documentation category, since most of the changes in the linked pull request are adding documentation. I've tried to take this into account while reviewing it, but if you really want a documentation moderator could review it instead (just reply to this comment saying so).

Tiny bit of feedback: the scrollbar shifts the page horizontally when going from a page without a scrollbar to a page with a scrollbar (and vice versa). There are a few solutions for this that can be found here.


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]

Thanks @amosbastian :)
Yeah, I wasn't sure about which category I should use.
If you think it makes more sense for a documentation moderator to review this contribution then I'd agree to that.

ps: Thanks for the feedback about the scrollbar, I'll add it to our backlog. :)

Thank you for your review, @amosbastian!

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

Hi @kareniel!

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

Congratulations @kareniel!
Your post was mentioned in the Steemit Hit Parade for newcomers in the following category:

  • Upvotes - Ranked 1 with 904 upvotes

I also upvoted your post to increase its reward
If you like my work to promote newcomers and give them more visibility on Steemit, consider to vote for my witness!

Congratulations @kareniel! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

Award for the number of upvotes received

Click on the badge to view your Board of Honor.
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

SteemitBoard Ranking update - Steem Power, Followers and Following added

Support SteemitBoard's project! Vote for its witness and get one more award!

Hey, @kareniel!

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!

Congratulations @kareniel! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You got more than 10 replies. Your next target is to reach 50 replies.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

The new Steemfest³ Award is ready!
Be ready for the next contest!

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @kareniel! You have received a personal award!

SteemFest 3 Attendee
Click on the badge to view your Board of Honor.

Do not miss the last post from @steemitboard:

SteemFest³ - SteemitBoard Contest Teaser
The new Steemfest³ Award is ready!

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @kareniel! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You made more than 50 upvotes. Your next target is to reach 100 upvotes.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

SteemFest3 and SteemitBoard - Meet the Steemians Contest

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @kareniel! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You made more than 50 comments. Your next target is to reach 100 comments.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

The Meet the Steemians Contest is over - Results are coming soon ...

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @kareniel! You received a personal award!

Happy Birthday! - You are on the Steem blockchain for 2 years!

You can view your badges on your Steem Board and compare to others on the Steem Ranking

Vote for @Steemitboard as a witness to get one more award and increased upvotes!