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

wise need more docs: docs, docs, docs #11

Closed
Gandalf-the-Grey opened this issue Jul 13, 2018 · 1 comment
Closed

wise need more docs: docs, docs, docs #11

Gandalf-the-Grey opened this issue Jul 13, 2018 · 1 comment
Assignees
Projects

Comments

@Gandalf-the-Grey
Copy link

Wise needs more docs for various groups of users.
ELI5 for voters, quickstart guide for easy adoption, in-depth guides for devs.

Put a user in front of a https://github.com/noisy-witness/steem-wise-core/
Alice wants to be use wise, she want to give Bob, Carlos and Dave a way to vote on her behalf.
Eve is a poweruser, she wants to contribute by creating rules.
Alice needs an ELI5+quickstart guide, easy steps on how to deploy it and use it.
Bob and Carlos an ELI5 guide on how to vote, Dave and Eve need a guide for devs.

Currently there's some info in README, with mixed level of complexity and target groups.

@Jblew Jblew self-assigned this Aug 9, 2018
@Jblew Jblew added this to Needs triage in Wise Aug 9, 2018
@Jblew Jblew moved this from Needs triage to TODO (High priority) in Wise Aug 9, 2018
@Jblew Jblew moved this from TODO (High priority) to Needs triage in Wise Aug 9, 2018
@noisy noisy moved this from Needs triage to TODO (High priority) in Wise Aug 13, 2018
@Jblew
Copy link
Member

Jblew commented Sep 22, 2018

Your suggestion was very important for us. Since it, we have already:

  • written a detailed manual: https://wise.vote/introduction
  • updated README in every repository. They are now very detailed.
  • added CONTRIBUTING.md guide to every repository. They are now very detailed.
  • created good and precise code documentation in steem-wise-core repository
  • created "wise init" command in steem-wise-cli which guides delegators through the daemon setup process.

@Jblew Jblew closed this as completed Sep 22, 2018
Wise automation moved this from TODO (High priority) to Closed Sep 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Wise
Closed/Deployed
Development

No branches or pull requests

2 participants