New Year, New DevPortal Updates

DPU.jpg

Hello Steemians. We’re kicking 2019 off with a whole bunch of devportal updates! Below you will find summaries for some of the updates, but for a complete list be sure to go to: https://github.com/steemit/devportal/pull/409.

Issue 384

A tutorial was added that demonstrates how to use the new API methods by explaining how developers can submit a transaction to the blockchain, and then use the new transaction polling API to determine the status of the transaction.

Issue #361

Documentation for a new transaction polling API was added. The plugins needed to enable this API on a steemd node were added along with a new section in “APPBASE API” for the new method prefixes that were added. New API definitions were also added to the "APPBASE API" section for the new methods.

Issue #371

Some changes were made to the plugin and API list from issue #269, in which documentation was created for steemd plugins. A link to the plugins was added to the menu. The plugin name that needs to be enabled within the config.ini file in order to turn on the plugin was clearly defined. All dependencies were reviewed to ensure that they are documented appropriately.

Issue #402

Some useful rake tasks were added mainly to improve the process for keeping up with continued changes to the devportal over time.

ops_dump

This task outputs all known ops, except virtual ops. We can use this to find undocumented ops. Using rake ops_dump # we can save the output to the project and run it later to find differences in new runs. rake ops_dump[true] will include virtual ops in the results and rake ops_dump[true,true] uses appbase naming.

test:proof

This task checks the HTML generated by Jekyll and other assets to find problems. In particular, it locates issues in HTML like duplicate IDs. This is most useful for avoiding issues that can impact dynamic features. The html-proofer gem is used and can be configured to be more or less opinionated. Currently, it is configured to look at:

["ImageCheck", "HtmlCheck", "ScriptCheck", "FaviconCheck", "LinkCheck"]

rake test:proof

Database API Details

Documentation on database_api has been expanded to include previously missing details with PR #404. Examples were added for each method in database_api. This is very useful because it includes some of the newer methods available in Steem.

Improving the DevPortal

The devportal is an important resource for developers who are interested in leveraging the Steem blockchain and we are excited to continue making improvements. For a complete list of all of the PRs that were merged, go here and be sure to check out our devportal at developers.steem.io.

The Steemit Team

H2
H3
H4
3 columns
2 columns
1 column
54 Comments