/README.md -> Description of the REPOSITORY. Not the addon (one repository can contain various addons). But this repo only has one addon. It must contain general information about the repo/addon, and how to add it to Home Assistant.
/[addon_folder]/README.md -> Description of the ADDON. It will appear in Home Assistant when selecting the addon.
/[addon_folder]/DOCS.md -> Configuration options for the ADDON. I will appear in the Configuration tab when selecting the addon.
This PR takes the old README .md and splits it, doing this changes:
/README.md -> There is only one addon, so this file contains the description of the addon. The ideal will be not to have this info twice, but I have not found a better way. It contains too the info about adding the repo to Home Assistant and links to the other two documents.
/hdd_tools/README.md -> Description of the ADDON.
/hdd_tools/DOCS.md -> Configuration options for the ADDON.
After reading the Home Assistant documentation https://developers.home-assistant.io/docs/add-ons/presentation, I think the documentation of the addons must have this structure:
This PR takes the old README .md and splits it, doing this changes: