diff --git a/README.md b/README.md index 6786e53..faeeb4f 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ If you used the installer, the app checks for updates on startup. If an update i ## Need help? -Find us on [Discord](https://discord.gg/VraYT2N3wd). +Find us on [Discord](https://discord.gg/VraYT2N3wd), or check out the [frequently asked questions](https://github.com/sleevezipper/hass-workstation-service/tree/develop). ## Development diff --git a/documentation/FAQ.md b/documentation/FAQ.md new file mode 100644 index 0000000..d7984e3 --- /dev/null +++ b/documentation/FAQ.md @@ -0,0 +1,25 @@ +# Frequently asked questions + +There are some common problems people encounter with hass workstations service, so if you run into a problem you should search this list. Most browsers have a search function you can access by pressing `CTRL` and `F` simultaniously. + +If you cannot solve your problem still, join the [discord server](https://discord.gg/VraYT2N3wd). + +### Where are config files located? + +You can find the configuration files inside of `%appdata%\Hass Workstation Service` on windows. + +|file|usage| +| --- | --- | +|configured-commands.json|stores all data about commands, including their properties| +|configured-sensors.json|stores information about sensors, including their properties| +|mqttbroker.json|stores data about your MQTT broker, dont share online| + + +### Are there any client logs? + +Check the logs folder, its stored in the same place as config files. + + +### I cannot find documentation on a new feature? + +You can submit a pull request with new documentation, ask on the [discord server](https://discord.gg/VraYT2N3wd), or check the [develop branch](https://github.com/sleevezipper/hass-workstation-service/tree/develop) for updated documentation.