Documentation

[bamhm182]

I see there is a readme and a demo. That is a descent start, but there isn't a great place to go learn about the features in depth. For example, it looks like there are account permissions and it seems like the admin user should be able to create accounts and set permissions. It also looks like the demo may be broken as I don't see a UI to do any of that. If there were docs, we could go read up about it and learn.

I understand that the project is in beta and things may change, but I feel like many of the features and workflows are solidified enough that it makes sense to document them and update them at each release. I am open to creating some documentation as this project looks very interesting to me and I wanted to open this discussion to get opinions on how the documentation should be handled and the types of things that should go in it.

Here are my opinions:

• mdbook in /docs which is published to a github page when a commit is made to the main branch.
• Primary features
  • Accounts (creation, permissions)
  • Tasks (Description, examples)
  • Habits (Description, examples)
  • Wishlist/Coins/Rewards
• Installation, to include config files and environment variables (I see there is a compose file in the repo already, but it doesn't have everything spelled out)
• Roadmap