chatgpt adjustments

roles/homeassistant/README.md

@@ -1,11 +1,10 @@
 # smarthome.homeassistant
 
-Builds and installs a custom [lscr.io/linuxserver/homeassistant](https://hub.docker.com/r/linuxserver/homeassistant) image, discoverable within a bridge network.
+Builds and install a custom <a href="https://hub.docker.com/r/linuxserver/homeassistant" target="_blank">lscr.io/linuxserver/homeassistant</a> image.
 
 ## Why a Custom Image?
 
-When HomeAssistant is deployed in a bridge network, the HomeKit integration is not discoverable by Apple Home.
-To resolve this, the HomeAssistant image is built using the original linuxserver image with [avahi-tools enabled](./templates/homeassistant-avahi-dockerfile.j2). For more details, please refer to this <a href="https://community.home-assistant.io/t/using-homekit-component-inside-docker/45409/45?page=2" target="_blank">community thread</a> for more details.
+When HomeAssistant is deployed in a bridge network, the HomeKit integration is not discoverable by Apple Home. To resolve this, the HomeAssistant image is built using the original LinuxServer image with [avahi-tools enabled](./templates/homeassistant-avahi-dockerfile.j2). For more details, please refer to this <a href="https://community.home-assistant.io/t/using-homekit-component-inside-docker/45409/45?page=2" target="_blank">community thread</a>.
 
 ## Role Variables
 
@@ -26,18 +25,18 @@ To resolve this, the HomeAssistant image is built using the original linuxserver
   - Required: no
 - `homeassistant_env`
   - Default: `{}`
-  - Description: Docker container environment variables. See [linuxserver/homeassistant](https://docs.linuxserver.io/images/docker-homeassistant/#environment-variables-e)
-  - Type: str
+  - Description: Docker container environment variables. See [linuxserver/homeassistant](https://docs.linuxserver.io/images/docker-homeassistant/#environment-variables-e).
+  - Type: dict
   - Required: no
 - `homeassistant_config`
   - Default: See [homeassistant_config_default](./vars/main.yml)
-  - Description: Configuration for [configuration.yaml](https://home-assistant.io/docs/configuration/)
-  - Type: object
+  - Description: Configuration for [configuration.yaml](https://home-assistant.io/docs/configuration/).
+  - Type: dict
   - Required: no
 - `homeassistant_homekit_config`
   - Default: See [homeassistant_homekit_config_default](./vars/main.yml)
-  - Description: Configuration for the [HomeKit integration](https://www.home-assistant.io/integrations/homekit)
-  - Type: object
+  - Description: Configuration for the [HomeKit integration](https://www.home-assistant.io/integrations/homekit).
+  - Type: dict
   - Required: no
 - `homeassistant_mdns_host_network_interface`
   - Default: `eth0`

roles/mosquitto/README.md

@@ -1,38 +1,38 @@
 # smarthome.mosquitto
 
-Installs the [eclipse-mosquitto](https://github.com/eclipse/mosquitto/tree/master/docker#docker-images) image.
+Installs the <a href="https://github.com/eclipse/mosquitto/tree/master/docker#docker-images" target="_blank">eclipse-mosquitto</a> image.
 
 ## Role Variables
 
 - `mosquitto_version`
   - Default: `latest`
-  - Description: See [published tags](https://hub.docker.com/_/eclipse-mosquitto/tags)
+  - Description: The version of the Mosquitto image to install. See [published tags](https://hub.docker.com/_/eclipse-mosquitto/tags).
   - Type: str
   - Required: no
 - `mosquitto_port`
   - Default: `1883`
-  - Description: MQTT listen port
+  - Description: The MQTT listen port.
   - Type: int
   - Required: no
 - `mosquitto_websocket_port`
   - Default: `9001`
-  - Description: MQTT WebSockets listen port
+  - Description: The MQTT WebSockets listen port.
   - Type: int
   - Required: no
 - `mosquitto_install_dir`
   - Default: `/opt/docker/mosquitto`
-  - Description:
+  - Description: The directory where Mosquitto will be installed.
   - Type: str
   - Required: no
 - `mosquitto_env`
   - Default: `{}`
-  - Description: Docker container environment
-  - Type: str
+  - Description: Docker container environment variables.
+  - Type: dict
   - Required: no
 - `mosquitto_user`
   - Default: `{ name: "{{ ansible_user }}", password: "mosquitto" }`
-  - Description: Authentication for Mosquitto instance. [See docs](https://mosquitto.org/documentation/authentication-methods)
-  - Type: { name: str; password: str }
+  - Description: Authentication credentials for the Mosquitto instance. [See docs](https://mosquitto.org/documentation/authentication-methods).
+  - Type: dict with keys `name` (str) and `password` (str)
   - Required: no
 
 ## Dependencies

roles/smarthome/README.md

@@ -1,6 +1,6 @@
 # smarthome.smarthome
 
-All-in-one role to install [homeassistant](../homeassistant/readme.md), [mosquitto](../mosquitto/readme.md) and [zigbee2mqtt](../zigbee2mqtt/readme.md).
+An all-in-one role to install [HomeAssistant](../homeassistant/readme.md), [Mosquitto](../mosquitto/readme.md), and [Zigbee2MQTT](../zigbee2mqtt/readme.md).
 
 ## Requirements
 
@@ -10,17 +10,17 @@ All-in-one role to install [homeassistant](../homeassistant/readme.md), [mosquit
 
 - `smarthome_network`
   - Default: `smarthome`
-  - Description: Overrides [homeassistant_network](../homeassistant/readme.md#role-variables) [mosquitto_network](../mosquitto/readme.md#role-variables) and [zigbee2mqtt_network](../zigbee2mqtt/readme.md#role-variables)
+  - Description: Overrides the network for [HomeAssistant](../homeassistant/readme.md#role-variables), [Mosquitto](../mosquitto/readme.md#role-variables), and [Zigbee2MQTT](../zigbee2mqtt/readme.md#role-variables).
   - Type: str
   - Required: no
 - `smarthome_user`
   - Default: `{ name: "{{ ansible_user }}", password: "smarthome" }`
-  - Description: Overrides [mosquitto_user](../mosquitto/readme.md#role-variables) and [zigbee2mqtt_user](../zigbee2mqtt/readme.md#role-variables)
-  - Type: { name: str; password: str }
+  - Description: Overrides the users for [Mosquitto](../mosquitto/readme.md#role-variables) and [Zigbee2MQTT](../zigbee2mqtt/readme.md#role-variables).
+  - Type: dict with keys `name` (str) and `password` (str)
   - Required: no
 - `smarthome_zigbee_coordinator`
   - Default: ``
-  - Description: Overrides [zigbee2mqtt_device](../zigbee2mqtt/readme.md#role-variables)
+  - Description: Specifies the Zigbee coordinator device. Overrides [zigbee2mqtt_device](../zigbee2mqtt/readme.md#role-variables).
   - Type: str
   - Required: yes
 

roles/zigbee2mqtt/README.md

@@ -1,6 +1,6 @@
 # smarthome.zigbee2mqtt
 
-Installs the [koenkk/zigbee2mqtt](https://hub.docker.com/r/koenkk/zigbee2mqtt/) image.
+Installs the <a href="https://hub.docker.com/r/koenkk/zigbee2mqtt/" target="_blank">koenkk/zigbee2mqtt</a> image.
 
 ## Requirements
 
@@ -11,37 +11,37 @@ Installs the [koenkk/zigbee2mqtt](https://hub.docker.com/r/koenkk/zigbee2mqtt/)
 
 - `zigbee2mqtt_version`
   - Default: `latest`
-  - Description: See [published tags](https://hub.docker.com/r/koenkk/zigbee2mqtt/tags)
+  - Description: The version of the Zigbee2MQTT image to install. See [published tags](https://hub.docker.com/r/koenkk/zigbee2mqtt/tags).
   - Type: str
   - Required: no
 - `zigbee2mqtt_network`
   - Default: `zigbee2mqtt`
-  - Description:
+  - Description: The name of the Docker network.
   - Type: str
   - Required: no
 - `zigbee2mqtt_port`
   - Default: `8124`
-  - Description: Application WebUI
+  - Description: The port for the Zigbee2MQTT WebUI.
   - Type: int
   - Required: no
 - `zigbee2mqtt_install_dir`
   - Default: `/opt/docker/zigbee2mqtt`
-  - Description:
+  - Description: The directory where Zigbee2MQTT will be installed.
   - Type: str
   - Required: no
 - `zigbee2mqtt_env`
   - Default: `{}`
-  - Description: Docker container environment. See [zigbee2mqtt.io](https://www.zigbee2mqtt.io/guide/installation/02_docker.html#running-the-container)
-  - Type: str
+  - Description: Docker container environment variables. See [zigbee2mqtt.io](https://www.zigbee2mqtt.io/guide/installation/02_docker.html#running-the-container).
+  - Type: dict
   - Required: no
 - `zigbee2mqtt_config`
   - Default: See [zigbee2mqtt_config_default](./vars/main.yml)
   - Description: Configuration for [configuration.yaml](https://www.zigbee2mqtt.io/guide/configuration/#configuration). **Must include** [server](https://www.zigbee2mqtt.io/guide/configuration/mqtt.html#server-connection) to operate.
-  - Type: object
+  - Type: dict
   - Required: yes
 - `zigbee2mqtt_device`
   - Default: ``
-  - Description: Path to Zigbee Adapter. See [requirements](#requirements).
+  - Description: Path to the ZigBee Adapter. See [requirements](#requirements).
   - Type: str
   - Required: yes