ethereum/homestead-guide

Ethdocs isn't maintained

jamesray1 opened this issue · 12 comments

I've tried to raise this question, but it seems no one cares about it.

I've created an unlicense for this repo in a PR here, so that the repo can be forked and modified by anyone, e.g. in this repo here.

@jamesray1
OK cloning a repository that is not active enough is fine, now at https://github.com/Ethereum-community/homestead-guide

But how about updating https://ethereum-homestead.readthedocs.io/en/latest/ ?

@paulvi TBH I haven't maintained https://github.com/Ethereum-community/homestead-guide either. I think having a wiki is a better approach, at least if there is nobody who is willing to make sure all changes are moderated. https://github.com/ethereum/wiki/wiki. Additionally now that Constantinople has been merged and we are now in part 1 of Metropolis, the Homestead guide is best used as a historical reference, IMO. The wiki is preferable for maintaining. If there are concerns with grafitti the content could be moved to a more moderated or moderatable wiki, e.g. like Bitcoin wiki.

Additionally the license for this repo was changed to CC BY-SA-4.0, so anyone should be able to edit it without having copyright issues now. I can add others as a contributor to that repo, however I suggest talking to maintainers here to discuss being added as a contributor to that repo, if interested. You could make a PR to update that page.

Just learned that https://ethereum-homestead.readthedocs.io/en/latest/ = http://ethdocs.org/en/latest/

and while this repository says that

Legacy Docs
Ethereum Wiki: https://github.com/ethereum/wiki/wiki

That is wiki is legacy, in fact https://github.com/ethereum/wiki/wiki is still being updated.

So the first problem seems what is actually place for documentation?

@jamesray1 Can you rename this issue to "this repository (Ethdocs) isn't maintained"
or even "THIS REPOSITORY (Ethdocs.org) IS NOT MAINTAINED"

referencing @pirapira Yoichi Hirai who could do latest PR merges.

@paulvi it may be a stretch to say that it is not maintained, maintainers may maintain it, albeit it may require prompting. I'll close this issue.

I've been prompted. Currently six PRs are open, and I've left a comment on every one of them.

I would say that https://github.com/ethereum/wiki/wiki is a more appropriate place for documentation. Vitalik Buterin, myself and others edit it. And anyone can freely edit it without having to be added as a collaborator to the repo or require collaborators to review PRs.

Yoichi, sorry to make it look like I was blaming you, note that I did say it it may require prompting. I haven't looked into the context.

Regarding the legacy doc reference to the wiki I made a PR for that: #440.

I also updated that PR to refer to the wiki as an alternative to this guide.