✏️ Split add-on documentation

README.md

@@ -40,194 +40,7 @@ management solution for your home, delivering features like:
 
 [Try out the online demo of Grocy][grocy-demo].
 
-## Installation
-
-The installation of this add-on is pretty straightforward and not different in
-comparison to installing any other Home Assistant add-on.
-
-1. Search for the "Grocy" add-on in the Supervisor add-on store.
-1. Install the "Grocy" add-on.
-1. Start the "Grocy" add-on.
-1. Check the logs of the "Grocy" add-on to see if everything went well.
-1. Click on the "OPEN WEB UI" button to get into the interface of Grocy.
-1. The default login is user: `admin` password: `admin`.
-1. Enjoy the add-on!
-
-## Configuration
-
-**Note**: _Remember to restart the add-on when the configuration is changed._
-
-Example add-on configuration:
-
-```yaml
-culture: en
-currency: USD
-entry_page: stock
-features:
-  batteries: true
-  calendar: true
-  chores: true
-  equipment: true
-  recipes: true
-  shoppinglist: true
-  stock: true
-  tasks: true
-tweaks:
-  chores_assignment: true
-  multiple_shopping_lists: true
-  stock_best_before_date_tracking: true
-  stock_location_tracking: true
-  stock_price_tracking: true
-  stock_produc_freezing: true
-  stock_product_opened_tracking: true
-log_level: info
-ssl: false
-certfile: fullchain.pem
-keyfile: privkey.pem
-```
-
-**Note**: _This is just an example, don't copy and paste it! Create your own!_
-
-### Option: `log_level`
-
-The `log_level` option controls the level of log output by the addon and can
-be changed to be more or less verbose, which might be useful when you are
-dealing with an unknown issue. Possible values are:
-
-- `trace`: Show every detail, like all called internal functions.
-- `debug`: Shows detailed debug information.
-- `info`: Normal (usually) interesting events.
-- `warning`: Exceptional occurrences that are not errors.
-- `error`:  Runtime errors that do not require immediate action.
-- `fatal`: Something went terribly wrong. Add-on becomes unusable.
-
-Please note that each level automatically includes log messages from a
-more severe level, e.g., `debug` also shows `info` messages. By default,
-the `log_level` is set to `info`, which is the recommended setting unless
-you are troubleshooting.
-
-### Option: `ssl`
-
-Enables/Disables SSL (HTTPS) on the web interface of Grocy
-Panel. Set it `true` to enable it, `false` otherwise.
-
-### Option: `certfile`
-
-The certificate file to use for SSL.
-
-**Note**: _The file MUST be stored in `/ssl/`, which is the default_
-
-### Option: `keyfile`
-
-The private key file to use for SSL.
-
-**Note**: _The file MUST be stored in `/ssl/`, which is the default_
-
-### Option: `culture`
-
-Is used for setting the language. Choose between:
-
-- `da` (Danish)
-- `de` (German)
-- `en` (English)
-- `en_GB` (English - United Kingdom)
-- `es` (Spanish)
-- `fr` (French)
-- `hu` (Hungarian)
-- `it` (Italian)
-- `nl` (Dutch)
-- `no` (Norwegian)
-- `pl` (Polish)
-- `pt_BR` (Portuguese - Brazil)
-- `pt_PT` (Portuguese - Portugal)
-- `ru` (Russian)
-- `sk_SK` (Slovak - Slovakia)
-- `sv_SE` (Swedish - Sweden)
-- `ta` (Tamil)
-- `tr` (Turkish)
-
-### Option: `currency`
-
-Determines the currency as displayed in the Grocy interface, specified by the
-ISO4217 three digit currency code.
-
-Examples:  `USD`, `CAD`, `GBP` or `EUR`.
-
-### Option: `entry_page`
-
-Allows you to specify an custom homepage if desired.
-
-You can use the one of the following values:
-
-- `batteries`
-- `calendar`
-- `chores`
-- `equipment`
-- `mealplan`
-- `recipes`
-- `shoppinglist`
-- `stock`
-- `tasks`
-
-By default the homepage is set to the stock overview.
-
-### Option: `features`
-
-Is used for enable or disable features in Grocy. Disabled features
-are hidden from the web interface. The following features can be enabled
-or disabled:
-
-- `batteries`
-- `calendar`
-- `chores`
-- `equipment`
-- `recipes`
-- `shoppinglist`
-- `stock`
-- `tasks`
-
-Set it `true` to enable it, `false` otherwise.
-
-### Option: `tweaks`
-
-These options are used to tweak part of the core behavior of Grocy.
-The following sub features can be enabled or disabled:
-
-- `chores_assignment`
-- `multiple_shopping_lists`
-- `stock_best_before_date_tracking`
-- `stock_location_tracking`
-- `stock_price_tracking`
-- `stock_product_freezing`
-- `stock_product_opened_tracking`
-
-Set it `true` to enable it, `false` otherwise.
-
-The following sub features can be set to specify a day (0-6), where 0 would
-equal Sunday:
-
-- `calendar_first_day_of_week`
-- `meal_plan_first_day_of_week`
-
-## Known issues and limitations
-
-- Grocy support to provide custom lookup resources to lookup information
-  on the internet based on the product barcode. This is currently not yet
-  supported by the add-on.
-
-## Changelog & Releases
-
-This repository keeps a change log using [GitHub's releases][releases]
-functionality. The format of the log is based on
-[Keep a Changelog][keepchangelog].
-
-Releases are based on [Semantic Versioning][semver], and use the format
-of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
-based on the following:
-
-- ``MAJOR``: Incompatible or major changes.
-- ``MINOR``: Backwards-compatible new features and enhancements.
-- ``PATCH``: Backwards-compatible bugfixes and package updates.
+[:books: Read the full add-on documentation][docs]
 
 ## Support
 
@@ -304,6 +117,7 @@ SOFTWARE.
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
 [dockerhub]: https://hub.docker.com/r/hassioaddons/grocy
+[docs]: https://github.com/hassio-addons/addon-grocy/blob/master/grocy/DOCS.md
 [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
 [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-grocy/112422?u=frenck
 [frenck]: https://github.com/frenck
@@ -313,10 +127,8 @@ SOFTWARE.
 [gitlabci]: https://gitlab.com/hassio-addons/addon-grocy/pipelines
 [grocy-demo]: https://demo-en.grocy.info
 [grocy]: https://grocy.info/
-[home-assistant]: https://home-assistant.io
 [i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
 [issue]: https://github.com/hassio-addons/addon-grocy/issues
-[keepchangelog]: http://keepachangelog.com/en/1.0.0/
 [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-grocy.svg
 [maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
 [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
@@ -327,4 +139,3 @@ SOFTWARE.
 [releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-grocy.svg
 [releases]: https://github.com/hassio-addons/addon-grocy/releases
 [repository]: https://github.com/hassio-addons/repository
-[semver]: http://semver.org/spec/v2.0.0.htm

grocy/.README.j2

@@ -24,8 +24,6 @@ management solution for your home, delivering features like:
 
 [Try out the online demo of Grocy][grocy-demo].
 
-[Click here for the full documentation][docs]
-
 ![Grocy screenshot][screenshot]
 
 {% if channel == "edge" %}
@@ -69,7 +67,6 @@ If you are more interested in stable releases of our add-ons:
 {% endif %}
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
-[docs]: {{ repo }}/blob/{{ version }}/README.md
 [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
 [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-grocy/112422?u=frenck
 [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png