steem.readthedocs.io does not reference this repo

steemit / steem-python

The official Python (3) library for the Steem Blockchain.

https://steem.io

MIT License

153 stars 99 forks source link

steem.readthedocs.io does not reference this repo #62

Open theoreticalbts opened 6 years ago

theoreticalbts commented 6 years ago

I started reading the docs, on http://steem.readthedocs.io/ as suggested by README.md. That site says:

"steem-python is the official STEEM library for Python. It comes with a BIP38 encrypted wallet and a practical CLI utility called stemepy."

I wanted to submit a PR to change the typo stemepy, but I found (by clicking on the "Edit on GitHub" link) that the readthedocs site references the Netherdrake repo.

I propose one of the following two solutions:

(a) Change the readthedocs setup to point the steem.readthedocs.io URL to documentation generated from this repo (steemit/steem-python) instead of netherdrake/steem-python.
(b) If solution (a) is not possible, create a new documentation hosting URL for this repo (on readthedocs or otherwise). Then change the README.md in this repo to point to that URL.

Netherdrake commented 6 years ago

I've offered to give away the steem.readthedocs.io namespace a few months ago, and the offer is still open. @sneak if you want it, just ping me @ anytime.

sneak commented 6 years ago

We don't want to use that site/URL. Please delete it. The authoritative documentation for steem-js and steem-python will be located within their respective repos, and will be extracted, hosted, and displayed on our devportal.

//cc @goldibex

aaroncox commented 6 years ago

I use the steem.readthedocs.io site all the time for reference, don't delete it until you've got something else up IMO. There are likely many more like myself who use it.

Netherdrake commented 6 years ago

I don't want to infringe on Steem's name, or confuse people about where the official documentation is. At the same time, current documentation is in use by people.

I'm looking forward to guidance on what should I do.

sneak commented 6 years ago

As soon as our devportal's up (with the same docs from the repo), please feel free to kill off the RTD site if you wish. You're not infringing anything by hosting MIT-licensed docs there - but they will eventually get out of date and our canonical docs will be at the devportal.

Netherdrake commented 6 years ago

When the devportal has the Python docs, I will deprecate the package and refer to steemit/steem-python and devportal.

cyon1c commented 6 years ago

Our devportal still links to the RTD site. We need this switched.