steemit / steem-python

The official Python (3) library for the Steem Blockchain.
https://steem.io
MIT License
153 stars 98 forks source link

Better code and examples for developer portal #3

Open john-g-g opened 7 years ago

john-g-g commented 7 years ago

Some examples would be useful for the developer portal. I think demonstrating how to do some of the tasks we think will be most common would be a start. @sneak felt they could live either in this repo or the portal repo. Since this is a python package (ostensibly usable without the dev portal), I think all docs/examples should live here and somehow find their way to the dev portal too. Most of the examples already exist here: https://steem.readthedocs.io/en/latest/steem.html#quick-start, so we need the api docs and examples on the developer portal.

Netherdrake commented 7 years ago

I think we first need to improve Sphinx documentation, in 3 ways.

After that we can extract a more succinct version of documentation into markdown, and publish it as repo Readme as well as in dev portal.