steem-python icon indicating copy to clipboard operation
steem-python copied to clipboard

Better code and examples for developer portal

Open john-g-g opened this issue 7 years ago • 2 comments

john-g-g avatar May 02 '17 18:05 john-g-g

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.

john-g-g avatar May 02 '17 22:05 john-g-g

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

  • Document Steemd API
  • Document all python-steem public methods
  • Improve Getting Started / Tutorial section to have a more comprehensive, single page overview

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.

Netherdrake avatar May 03 '17 01:05 Netherdrake