Repository
https://github.com/steemdocs/steemdocs
Details
Steemdocs is a project that aims to build the equivalent of MDN for the Steem blockchain. The goal of SteemDocs is to be a one-stop shop for all Steem developers needs. Three things I've been working on with this bundle. First, enriching the Glossary which is the foundation to help anyone get familiar with the lingo. Second, is a place to hold all the hardfork release notes with method and operations introduced in them starting from HF2. Finally, I've added YAML to every markdown document so that we can start optimizing for SEO.
The HF releases note and the glossary 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!
The Glossary Bundle #10 are glossary terms centered around the transactions:
- Authority
- Transaction
- Transaction Hex
HF Release Notes
This bundle has the overview of the first two Hardfork (HF2 and HF3). These will be the templates of more complicated hardforks. Even though there isn't any new method or operation introduced, they give a historical context of where the Steem blockchain come from.
YAML
YAML is a convenient way to enter data in a markdown file for use on the website. We have introduced the title tag and a description tag for every file in order to generate the title tag and description tag for SEO.
We haven't introduced tags at this point since we want to make sure to have a good tag structure for discoverability down the line.
Links
https://steemdocs.net/glossary/
GitHub Proof of Authorship
GitHub Account: https://github.com/RenaudGagne
Pull Requests:
- https://github.com/steemdocs/steemdocs/pull/14 (Add YAML)
- https://github.com/steemdocs/steemdocs/pull/16 (Debug)
- https://github.com/steemdocs/steemdocs/pull/18 (HF2 + Release Folder)
- https://github.com/steemdocs/steemdocs/pull/19 (HF3, Glossary #10)