search

open-homebrewing-project / home-brewing-automation

The goal of this project is to define plans for an completely automated home brewing system.
6 stars 1 forks source link

How should we organize documentation? #1

Open codelitt opened 9 years ago

codelitt commented 9 years ago

I have built a Brewpi and have a half finished write up on buying all the parts in the states for ~$100 with 2 day shipping (go Prime!). Where would you want to put this? Wiki? Create a folder with .md files? a Github.io blog?

AgentO3 commented 9 years ago

I think a folder of markdown files in the repo would be best.

I think an outline would be a good idea also. I have to do some looking around and see how other similar projects structure their information.

codelitt commented 9 years ago

Cool. It may be useful to create an organization. We can fork popular project repos into the organization, keep this repo for documentation, and add any repos (for working code) that we create to the organization.

Also https://www.draw.io/ might be a good option for diagraming the brew process/equipment profiles.