These are chat archives for ethereum/homestead-guide

23rd
Feb 2016
Bob Summerwill
@bobsummerwill
Feb 23 2016 01:25
OK - off we go! ethereum/homestead-guide#48
Bob Summerwill
@bobsummerwill
Feb 23 2016 01:53
I assume that the whole "The Homestead Documentation Initiative" section will be chopped out before we publish? Because it is meta-documentation for us, which is likely just confusing and unnecessary for end-users?
And that "Introduction" will be the first section?
Hudson Jameson
@Souptacular
Feb 23 2016 01:54
Correct :)
Sorry I have been on less frequently the last week, I am at a conference all this week and had to do more work than usual to prepare.
Pablo Zapata
@pablox43
Feb 23 2016 01:56
hey @zelig
The comments are unfortunately non-tenchnical :)
but
I did find many areas that we could update
I sent the updates to @Souptacular
Bob Summerwill
@bobsummerwill
Feb 23 2016 01:58
Thanks, @Souptacular. I have a working end-to-end pipeline now, so I will write some actual content, and make some more PRs.
Hudson Jameson
@Souptacular
Feb 23 2016 01:59
Great!
@pablox43 Sorry I have not gotten to merging your comments yet, will do ASAP
Pablo Zapata
@pablox43
Feb 23 2016 02:00
it's all good!
Hudson Jameson
@Souptacular
Feb 23 2016 02:00
I have merged some PRs and have to run, I will look at @zelig 's comments more closely later, but so far they all seem just fine. The one exception is putting contract information in the Introduction section. I believe it is an advanced enough topic to go into either "Contracts and Transaction" or "Developing on Ethereum"
I see it as:
THe basics = introduction
COntracts and transactions = Intermediate
Developing on Ethereum = hard, so beyond end user just wanting to interact with a contract generally
Pablo Zapata
@pablox43
Feb 23 2016 02:07
That sounds about right
Bob Summerwill
@bobsummerwill
Feb 23 2016 02:40

So https://www.reddit.com/r/ethereum/comments/44qk0i/ethereum_homestead_project_preview_website_release/ looks kick-ass. There is a lot of overlap between that, and the docs which we are building here.

What is the rationale for keeping these separate? What are the intended "lines" between existing Wiki, ethereum.org and Homestead Guide?

Viktor Trón
@zelig
Feb 23 2016 04:53
I don't see much overlap,
The website contains basic info and very detailed hands on tutorials
The website will deep link to the guide sections, while the guide will list the tutorials in the dapp development section
The rationale of the guide is to be as exhaustive as possible at this stage when it comes to technical info. This is the last time in history this is remotely realistic
@bobsummerwill thanks a lot for pr and let me know if you keep working on something
Viktor Trón
@zelig
Feb 23 2016 04:59
@Souptacular I think ether intro, contract and gas intro should go to basics, while detailed info on contract writing and deployment and transactions etc being to developing chapter. Conclusion: nothing left of the accounts and contracts chapter
Alex Van de Sande
@alexvandesande
Feb 23 2016 12:59
@bobsummerwill I’d love to put more deeplinks to homestead guide on the tutorials, I accept suggestions
Alex Van de Sande
@alexvandesande
Feb 23 2016 14:03
I think we should add a section called ‘starting up the command line client’ between “installing the client” and “connecting to the network”
I can help with that section
Viktor Trón
@zelig
Feb 23 2016 14:19
I have old material on that too
Great suggestion
Alex Van de Sande
@alexvandesande
Feb 23 2016 14:55
I’m updating old links on the site and here’s what I’ve seen missing so far:
Bob Summerwill
@bobsummerwill
Feb 23 2016 17:28
@alexvandesande For Mac instructions for eth, please just link to https://github.com/ethereum/webthree-umbrella/wiki/Building-on-OS-X. I have been iterating on that page a ton, and it would be very silly to cut-and-paste it elsewhere. More generally, I think that pattern likely holds for the "install instructions" for all the client software. We are likely better served with making them into good pages to link against, wherever they live, rather than cut-and-pasting. They will inevitably 'go rotten' that way. I imagine that we ARE going to try to get "one-liner" installs available for geth and eth again, though, eh?
^ RE: "one liner installs?" - @chriseth, @tgerring
^ 75 revisions on that page, since I took it over in November or so.
chriseth
@chriseth
Feb 23 2016 17:30
@bobsummerwill yes, let's make one line installs (did not read the whole question)
@bobsummerwill the issue is here: ethereum/webthree-umbrella#165