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

Update documentation #364

Closed
3 tasks done
0xGabi opened this issue Feb 15, 2019 · 1 comment
Closed
3 tasks done

Update documentation #364

0xGabi opened this issue Feb 15, 2019 · 1 comment
Assignees
Labels
📚 docs An addition or correction of the API documentation

Comments

@0xGabi
Copy link
Contributor

0xGabi commented Feb 15, 2019

close #349 , #348

The current documentation is not up to date and there is a more and more demand to include new changes. Also there are lot of information distribute between forum.aragon (like this great guide made by Luke, similar questions answered in aragon.chat, boilerplates readme and hack.aragon.

This is not a please experience for a dev starting with aragonCLI so this issue will include a thoughtful review of all the documentation currently available in all places aiming to unify it in hack.aragon. At the same time, it make sense to restructure documentation on hack.aragon to include:

  • Quick start / Overview / Introduction
  • Guides around specific subjects (e.g.: Publish to different environments, Using a different Ethereum account, Propagating content, etc), similar to this
  • FAQ section. We have this currently, but it should be it's own section and much more elaborate (If there is a recurring question on #dev-help we will add it there)

TODO:

  • Update exiting documentation

  • Related issues

  • Restructure documentation on hack.aragon

Note: I reported this issue here to been able to track it in our milestones

@0xGabi 0xGabi added 📚 docs An addition or correction of the API documentation Epic labels Feb 15, 2019
@0xGabi 0xGabi added this to the aragonCLI v5.5 milestone Feb 25, 2019
@0xGabi 0xGabi self-assigned this Feb 25, 2019
@0xGabi
Copy link
Contributor Author

0xGabi commented Mar 11, 2019

Achieved in aragon/hack#99

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs An addition or correction of the API documentation
Projects
None yet
Development

No branches or pull requests

1 participant