-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft: Improved getting-started page #139
Conversation
started work on issue aragon#104 + empathy for web3 newbies.
Fix typo + edit.
Add Mac considerations
Add empathy to quick start
start fleshing out 'What is Aragon and what does it do'
add introduction
intro edits
add further reading subsection to intro
Flesh out 'More on DAOs' subsection
minor edits + ellipses as placeholders
intro edits: clarify link between Aragon Apps and DAOs
intro edits
intro edits
intro edits
intro edit
start fleshing out web3 subsection
web3 subsection additions + edits
For getting-started.md
for getting-started.md
web3 subsection: add web2 vs web3 stack image + edits
environment setup edits. start fleshing out web3 provider text
Metamask subsection: quote update
Up and running: lots of little edits
add placeholders for tomorrow
Metamask subsection: add instructions modulo images
metamask subsection images
Metamask subsection: add images + edits
Interacting with your first DAO subsection: add instructions
intro edits
Fix error: cannot generate application artifact: Illegal char _ (The name of an App can't have an underscore)
Hey @hackingclimate I just submit #148 can you take a look when possible. Thanks |
Hey @0xGabi, had a look and left a comment: #148 (comment) I think it's a great start. |
@0xGabi, left some more suggestions on #148. On my side, Metamask guide is ready for review. Here's the link to the guide in blog post format: And here's the md version (docs/guides-use-metamask.md): https://github.com/hackingclimate/hack/blob/patch-1/docs/guides-use-metamask.md. |
@0xGabi can't seem to find a way to connect Frame to Localhost 8545. If it can't be done, I think we should consider moving the Signing your first transaction with Frame section from the getting started page to the tutorial. The logic being: the user can't interact with first-dao using Frame, and the point of the getting started page is to launch -- and interact with -- first-dao. What do you think? |
We can't use Frame to interact with the Getting started page app (see aragon#148 (comment)). As a result, the user should use Metamask. To avoid confusing the user, better to introduce Frame in the tutorial page.
@0xGabi here are some updates on my side:
Note that Frame is still mentioned in the second paragraph of the Web3 provider section:
And it's clear that it's our preferred provider. Tomorrow I'd like to start doing the same thing for the tutorial page -- i.e. make it accessible to developers with no prior web3 experience by explaining everything from first-principles. I propose to do this in a different pull request. What are your thoughts on all the above? Apologies if the tone is quite brusque! I haven't had much time to write this. |
Hey @hackingclimate thanks for the update. I'll review both articles and make them ready to merge. |
@hackingclimate I fixed some small things on Then made some style changes on the Metamask tutorial. I removed some of the image that seems repetitive. I think this is ready to be merged. I have a couple of comments for the GitHub tutorial:
|
@0xGabi awesome. Thanks for taking the time to review.
Agree. Images were for the first draft. Will standardize sizes -- perhaps a standard and another for close ups -- and replace with higher quality tomorrow.
Leaning towards the latter (documentation on the repo) since it isn't needed to create apps. What do you think? |
I'll go ahead and merge this PR and you can create a new one to update the GitHub tutorial images. I decide to create a new folder |
Hi everyone, excited to be making my first pull request here 😊. This is a draft PR for async comments (as @0xGabi requested).
The aim here is to make the getting-started page as accessible as possible. In particular, it should be accessible to developers with no prior web3 experience.
Note that this is very much still a work in progress. Some subsections need to be heavily edited, while others still need to be filled in. The general structure will also no doubt evolve.
I think an important thing that's missing right now are the prerequisites. Stating them explicitly will force us to think hard about what exactly needs to be included, and make sure the whole thing is entirely self-contained for those who meet them.
Thanks for reading. Looking forward to hearing your thoughts!