create account

Lightsteem documentation is up! by emrebeyler

View this thread on: hive.blogpeakd.comecency.com
· @emrebeyler · (edited)
$75.84
Lightsteem documentation is up!
![Screen Shot 2018-08-16 at 3.30.02 PM.png](https://ipfs.busy.org/ipfs/QmRJAfFXVUvZX1LwZ27akM4Zfo3F9M7KxMmSXRpbxaYcWA)

I have been working on the design of [lightsteem](https://github.com/emre) in the latest couple of weeks and I feel like the library is in a good state, so I have created a documentation for potential developers want to try the library.

#### It's online at [https://lightsteem.readthedocs.io](https://lightsteem.readthedocs.io/en/latest/)
***

#### Documentation Pages
***

- [Index](https://lightsteem.readthedocs.io/en/latest/)
- [Getting Started](https://lightsteem.readthedocs.io/en/latest/gettingstarted.html)
- [Retry and Failover](https://lightsteem.readthedocs.io/en/latest/retryandfailover.html)
- [Broadcasting Transactions](https://lightsteem.readthedocs.io/en/latest/broadcasting.html)
- [Batch RPC calls](https://lightsteem.readthedocs.io/en/latest/batch_rpc_calls.html)

I have used [Sphinx](http://www.sphinx-doc.org/en/master/) and [rtfd.org](http://rtfd.org/) to write and host the documentation. All documentation files are stored at the [/docs](https://github.com/emre/lightsteem/tree/master/docs) folder inside ```.RST``` formatted files.

Let me know you if you're interested in the library and feel like there are missing concepts.

![Screen Shot 2018-08-16 at 3.47.43 PM.png](https://ipfs.busy.org/ipfs/QmS6QW4bqqW2NCXcGWpLBKyuCCwwWFPRqHcwthiDpf8sMC)

#### Contributing to the documentation
***

- Fork the repository
- Create a new branch. Eg: (typo-fix)
- Install sphinx sphinx-autobuild packages on your virtual environment.
- Run ```sphinx-autobuild docs docs/_build/html --port=8001```. This command will serve the documentation on http://localhost:8001.
- Make changes you want on .RST files.
- Create a pull request

#### Related commits
***
- [f355531](https://github.com/emre/lightsteem/commit/f355531e1770b51324af1cab0e872350c8057341)
- [2acf732](https://github.com/emre/lightsteem/commit/2acf7320786e8710035a1074ecd8cfc0c3362f2e)
- [1134d64](https://github.com/emre/lightsteem/commit/1134d64f6c1d5ebfbe5d789746f4daf72e309955)
- [0c55c72](https://github.com/emre/lightsteem/commit/0c55c72166472c0af317e1e7796220aae7e58c94)
πŸ‘  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 129 others
properties (23)
authoremrebeyler
permlinklightsteem-documentation-is-up
categorylightsteem
json_metadata{"community":"busy","app":"steemit/0.1","format":"markdown","tags":["lightsteem","utopian-io","documentation","python","programming"],"links":["https://github.com/emre","https://lightsteem.readthedocs.io/en/latest/","https://lightsteem.readthedocs.io/en/latest/gettingstarted.html","https://lightsteem.readthedocs.io/en/latest/retryandfailover.html","https://lightsteem.readthedocs.io/en/latest/broadcasting.html","https://lightsteem.readthedocs.io/en/latest/batch_rpc_calls.html","http://www.sphinx-doc.org/en/master/","http://rtfd.org/","https://github.com/emre/lightsteem/tree/master/docs","http://localhost:8001","https://github.com/emre/lightsteem/commit/f355531e1770b51324af1cab0e872350c8057341","https://github.com/emre/lightsteem/commit/2acf7320786e8710035a1074ecd8cfc0c3362f2e","https://github.com/emre/lightsteem/commit/1134d64f6c1d5ebfbe5d789746f4daf72e309955","https://github.com/emre/lightsteem/commit/0c55c72166472c0af317e1e7796220aae7e58c94"],"image":["https://ipfs.busy.org/ipfs/QmRJAfFXVUvZX1LwZ27akM4Zfo3F9M7KxMmSXRpbxaYcWA","https://ipfs.busy.org/ipfs/QmS6QW4bqqW2NCXcGWpLBKyuCCwwWFPRqHcwthiDpf8sMC"]}
created2018-08-16 15:52:00
last_update2018-08-17 08:44:36
depth0
children6
last_payout2018-08-23 15:52:00
cashout_time1969-12-31 23:59:59
total_payout_value58.517 HBD
curator_payout_value17.327 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length2,176
author_reputation448,535,049,068,622
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,403,531
net_rshares57,480,357,247,395
author_curate_reward""
vote details (193)
@jadnven ·
Interesting post my friend, invite visit my post https://steemit.com/steempress/@jadnven/an-old-wanderer-photo-tales .....  follow you
properties (22)
authorjadnven
permlinkre-emrebeyler-lightsteem-documentation-is-up-20180816t163836083z
categorylightsteem
json_metadata{"tags":["lightsteem"],"links":["https://steemit.com/steempress/@jadnven/an-old-wanderer-photo-tales"],"app":"steemit/0.1"}
created2018-08-16 16:06:27
last_update2018-08-16 16:06:27
depth1
children0
last_payout2018-08-23 16:06:27
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length134
author_reputation15,050,072,114,726
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,404,984
net_rshares0
@ms10398 ·
$5.01
Hello @emrebeyler,

That's really a gem contribution in my category.

When I see a contribution with such high-quality work I get bound to staff pick it and really appreciate it.

The work you have put in to make the documentation look decent and user-friendly and easy to start with is visible by the first look of the documentation.

Its great to see sphinx being used in documentation after some time. Its been a while since I last saw someone using it though I love it.

I have scored it as it deserves to be.

I would love to see the project getting more developed and the documentation getting expanded.

There's no specific thing I could suggest to improve in the quality side of this contribution. I can give my two cents that you can construct better your post on steem. You can put some elements of documentation in the post too.

I would like to highlight that in future updates try to bring major updates in the documentation so that the amount of work stays consistent and the quality and quantity of work is high in coming contributions.

Good Luck for the project! :)

Your contribution has been evaluated according to [Utopian policies and guidelines](https://join.utopian.io/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](https://review.utopian.io/result/4/2111122).

---- 
Need help? Write a ticket on https://support.utopian.io/. 
Chat with us on [Discord](https://discord.gg/uTyJkNm). 
[[utopian-moderator]](https://join.utopian.io/)
πŸ‘  , , , , , , ,
properties (23)
authorms10398
permlinkre-emrebeyler-lightsteem-documentation-is-up-20180816t220848077z
categorylightsteem
json_metadata{"tags":["lightsteem"],"users":["emrebeyler"],"links":["https://join.utopian.io/guidelines","https://review.utopian.io/result/4/2111122","https://support.utopian.io/","https://discord.gg/uTyJkNm","https://join.utopian.io/"],"app":"steemit/0.1"}
created2018-08-16 22:08:48
last_update2018-08-16 22:08:48
depth1
children2
last_payout2018-08-23 22:08:48
cashout_time1969-12-31 23:59:59
total_payout_value3.759 HBD
curator_payout_value1.247 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length1,573
author_reputation27,572,487,973,390
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,432,823
net_rshares3,859,236,278,628
author_curate_reward""
vote details (8)
@emrebeyler ·
Thanks for the detailed feedbacks and review.
properties (22)
authoremrebeyler
permlinkre-ms10398-re-emrebeyler-lightsteem-documentation-is-up-20180817t065247901z
categorylightsteem
json_metadata{"tags":["lightsteem"],"app":"steemit/0.1"}
created2018-08-17 06:52:48
last_update2018-08-17 06:52:48
depth2
children0
last_payout2018-08-24 06:52:48
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length45
author_reputation448,535,049,068,622
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,468,955
net_rshares0
@utopian-io ·
Thank you for your review, @ms10398!

So far this week you've reviewed 1 contributions. Keep up the good work!
properties (22)
authorutopian-io
permlinkre-re-emrebeyler-lightsteem-documentation-is-up-20180816t220848077z-20180819t011008z
categorylightsteem
json_metadata"{"app": "beem/0.19.42"}"
created2018-08-19 01:10:09
last_update2018-08-19 01:10:09
depth2
children0
last_payout2018-08-26 01:10:09
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length110
author_reputation152,955,367,999,756
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,651,300
net_rshares0
@steem-ua ·
Hi @emrebeyler! We are @steem-ua, a new Steem dApp, computing UserAuthority for all accounts on Steem. We are currently in test modus upvoting quality Utopian-io contributions! Nice work!
properties (22)
authorsteem-ua
permlinkre-lightsteem-documentation-is-up-20180817t041433z
categorylightsteem
json_metadata"{"app": "beem/0.19.54"}"
created2018-08-17 04:14:33
last_update2018-08-17 04:14:33
depth1
children0
last_payout2018-08-24 04:14:33
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length187
author_reputation23,214,230,978,060
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,457,606
net_rshares0
@utopian-io ·
Hey @emrebeyler
 **Thanks for contributing on Utopian**.
Congratulations! Your contribution was Staff Picked to receive a maximum vote for the documentation category on Utopian for being of significant value to the project and the open source community.

We’re already looking forward to your next contribution!

**Want to chat? Join us on Discord https://discord.gg/h52nFrV.**

<a href='https://v2.steemconnect.com/sign/account-witness-vote?witness=utopian-io&approve=1'>Vote for Utopian Witness!</a>
properties (22)
authorutopian-io
permlinkre-lightsteem-documentation-is-up-20180819t054033z
categorylightsteem
json_metadata"{"app": "beem/0.19.42"}"
created2018-08-19 05:40:33
last_update2018-08-19 05:40:33
depth1
children0
last_payout2018-08-26 05:40:33
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length501
author_reputation152,955,367,999,756
root_title"Lightsteem documentation is up!"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id68,667,206
net_rshares0