Better Docs

[yeqbfgxjiq]

Part of the mission of 1Hive is to create tools that make it easier for people to learn about, use, and build DAOs to empower their communities. As such, it makes sense that the MVP ships with basic user onboarding guides. Aragon already has some basic guides in their Wiki that explain how to use the Aragon client, but there are no guides/docs for TPS apps. We need to make them.

Some things to consider: (copied from Keybase chat)

• Documenting our processes and how members engage with the various applications
• Documenting how the social/organizational expectations of members and various roles within the organization.
• Documenting the applications we are using and how they can be installed (for the benefit of other organizations)
• Also document other Aragon apps which we are not currently using because they may not be discovered otherwise. If we do this perhaps we should maintain our own apm repo and then make sure anything that is submitted to the repo has consistent documentation?
  • @lkngtn @0xGabi if we're documenting other Aragon apps, is Aragon going to contribute to the 1Hive vault to fund our research and open source initiatives? For a project as large as Aragon, it seems a little silly that a volunteer group would be creating their docs and onboarding guides ¯\_(ツ)_/¯

UX

Most documentation is very boring and no one reads it.Anything that would make the docs/guides more interesting is going to be a huge win for us. Here's what I've thought of so far, but please share suggestions for anything else you think would help! :)

• decent formatting and spacing (not just 1 giant infinite scroll of text with some parts bold)
• emojis (apparently this is not a popular feature lol)
• pictures
• code examples
• interactive demos

Aragon Resources

• https://wiki.aragon.org/dev/apps/
• https://github.com/aragon/aragon-apps/
• https://wiki.aragon.org/tutorials/Aragon_User_Guide/#0-introduction

TPS Resources

TPS Apps used in 1Hive DAO

• Projects
• Allocations
• Dot Voting

app explanations and descriptions

• https://www.autark.xyz/aragon-apps
• https://medium.com/@stellarmagnet/that-planning-suite-live-on-rinkeby-c2332e2e5e27

GitHub repo

• https://github.com/AutarkLabs/planning-suite

guide for installing Autark apps:

• https://github.com/AutarkLabs/planning-suite/blob/master/docs/GETTING_STARTED.md

app demos

• https://rinkeby.autark.xyz

app screenshots (missing rewards)

• https://www.dropbox.com/s/tw478e6lsumvumr/App%20screenshots.zip?dl=0

recommended tutorial format

• https://medium.com/mybit-dapp/mybit-dao-tutorial-5b3bc093963b

Essentially, we just need to create a better docs template and then update our current docs.

[yeqbfgxjiq]

Work on this is being carried out in the 1HIve DAO Kit Docs Standard.