Your idea:
When a user first starts using a local installation of Homebrewery, there is very little documentation on how to set up a configuration file (file name, location, content) for the app to use.
I suggest we remedy that by creating a new text file in the project, which spells out where the configuration file should live (/config/), what it should be named (docker.json, local.json, etc), and what it should contain, spelling out what each configuration parameter is and what it's effect will be.
This document will need to be updated when new configuration items are added to the application.
Your idea:
When a user first starts using a local installation of Homebrewery, there is very little documentation on how to set up a configuration file (file name, location, content) for the app to use.
I suggest we remedy that by creating a new text file in the project, which spells out where the configuration file should live (
/config/), what it should be named (docker.json,local.json, etc), and what it should contain, spelling out what each configuration parameter is and what it's effect will be.This document will need to be updated when new configuration items are added to the application.