Skip to content
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: Aragon Agent Guide #167

Merged
merged 102 commits into from
Jun 17, 2019
Merged

Draft: Aragon Agent Guide #167

merged 102 commits into from
Jun 17, 2019

Conversation

unixpi
Copy link
Contributor

@unixpi unixpi commented Jun 1, 2019

Hi everyone. This is a draft PR for async comments. It complete part of #115

A couple of thoughts:

I'm pretty happy with Part 1 -- the in depth guide on how to install the Agent app with aragonCLI. Though it's possible I've misunderstood a couple of things about how --apm.ipfs.rpc and aragon ipfs work (see step 2).

For Part 2 -- show a good use case of using the Agent app -- I've chosen to go with @sohkai 's suggestion: Voting in another org. The other suggestions (interacting with Uniswap and opening a Maker CDP) seemed harder to do on Rinkeby. However I think we should also cover them in the guide. I've added them as section titles (along with @luisivan 's Aragon Trust) at the end.

Update: after discussing with @0xGabi, replaced the Uniswap use case with Compound (since there is a Compound testnet).

Thanks for taking the time to read. Looking forward to hearing your thoughts!

P.S. I had a lot of fun figuring this out. Even with all the issues that come with being on the bleeding edge 😉. It really is a beautiful design.

@unixpi unixpi mentioned this pull request Jun 1, 2019
@unixpi unixpi force-pushed the sach-agent-guide branch 6 times, most recently from 2d324bd to 9c4ef61 Compare June 1, 2019 12:56
add introduction to agent app guide

update agent app guide: edit intro and add prereq section

update guides-agent-app.md: minor edits

update guides-agent-app.md: minor edits
minor edit + setup next section: Installing the Agent app

tone edit

tone edit

flesh out 'installing aragonCLI' subsection

edit yesterday's work
flesh out step 3: setting permissions section

add dao apps tables

Update Step 3: Setting permissions

Minor minor edit
Update dao acl explanation + edit structure

Minor edit

structure edit

structure edit

minor edit
Minor edit

Setup: Step 3 edits

Setup: Step 4 edits

Edits

Setup: Step 4 edits

Use case A edits

Use case A edits

Use case A edit

Use case A edit

Use case A edit

Use case A edits

Use case A edits

Use case A edits

Use case A edits

Use case A edits

Text + style edits

Style edit

Tidy up a few things + add notes

Minor edit

Minor edit

Edits

Edits

Edits

Edits

minor edits

minor edit

minor edits

minor edit

minor edit

Use case A: minor edits

edits

Minor edit

Add images + edits

Use case A: minor edits

Use case A: edits

Setup: steps 1 + 2 edits

Setup: step 3 edits

Setup: step 3 edits

Setup: step 3 edits

Setup: step 4 edits

Minor edits

explain dao exec

Edit dao exec explanation

Explain Token Manager's Mint method

minor edit

minor edit

Add images of Agent guide

Add images to Setup step 2

Adjust image dimensions

Adjust image dimensions

Add text explaining images

Edits

Edit image text style

Minor edit

Setup section 3 style edits

Edits

Fix typo

minor edits + notes to self

Add small conclusion to Use case A

Explain dao act

Add metadata: id, title, and sidebar_label

Minor edit

Use case A conclusion edit

Edits

Add image highlighting vote id

Add link to image highlighting vote id

Update voter id image caption

Update voter id image caption

Update voter id image caption

Add more images

Add links to new images

Add explanations to images highlighting permissions

Minor edit

Edits

Correct link

Minor edit

Minor edit

Minor edits

Minor edit

Remove height from images to allow accurate rescaling  on browser resize
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
@unixpi
Copy link
Contributor Author

unixpi commented Jun 1, 2019

Update: added a prerequisite section for those who've never interacted with an Aragon app before.

Fix typo

Co-Authored-By: Gabriel Garcia <[email protected]>
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
Copy link
Contributor

@izqui izqui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for incorporating the feedback @hackingclimate! One minor comment

docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
docs/guides-agent-app.md Outdated Show resolved Hide resolved
@0xGabi 0xGabi merged commit 796984d into aragon:master Jun 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants