doc: review documentation

docs/customservices.md

@@ -1,45 +1,49 @@
-# Custom Services
+# Smart cards
 
-Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
-configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any
-apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey
-if your homer instance is secured behind some form of authentication or access restriction.
+Some cards can use a specific a component that provides some extra features by adding a `type` key to the service yaml
+configuration and other parameters when needed.
 
-Available services are in `src/components/`. Here is an overview of all custom services that are available
+> [!WARNING]  
+> Note that `config.yml` is exposed at `/assets/config.yml` via HTTP and any sensitive information, like api keys,
+> included in the configuration file is exposed to anyone who can access the homer instance. Only include an api key
+> if your homer instance is secured behind some form of authentication or access restriction.
+
+Available services are in `src/components/`. Here is an overview of all smart cards that are available
 within Homer:
 
-- [Custom Services](#custom-services)
-  - [Common options](#common-options)
-  - [PiHole](#pihole)
-  - [OpenWeatherMap](#openweathermap)
-  - [Medusa](#medusa)
-  - [Lidarr, Prowlarr, Sonarr, Readarr and Radarr](#lidarr-prowlarr-sonarr-readarr-and-radarr)
-  - [PaperlessNG](#paperlessng)
-  - [Ping](#ping)
-  - [Prometheus](#prometheus)
-  - [AdGuard Home](#adguard-home)
-  - [Portainer](#portainer)
-  - [Emby / Jellyfin](#emby--jellyfin)
-  - [Uptime Kuma](#uptime-kuma)
-  - [Tautulli](#tautulli)
-  - [Mealie](#mealie)
-  - [Healthchecks](#healthchecks)
-  - [Proxmox](#proxmox)
-  - [rTorrent](#rtorrent)
-  - [qBittorrent](#qbittorrent)
-  - [CopyToClipboard](#copy-to-clipboard)
-  - [Speedtest Tracker](#SpeedtestTracker)
-  - [What's Up Docker](#whats-up-docker)
-  - [SABnzbd](#sabnzbd)
-  - [OctoPrint](#octoprint)
-  - [Tdarr](#tdarr)
-  - [PiAlert](#pialert)
-  - [Immich](#immich)
-  - [OpenHAB](#openhab)
-  - [Jellystat](#jellystat)
-  - [Home Assistant](#home-assistant)
+- [Common options](#common-options)
+- [PiHole](#pihole)
+- [OpenWeatherMap](#openweathermap)
+- [Medusa](#medusa)
+- [Lidarr, Prowlarr, Sonarr, Readarr and Radarr](#lidarr-prowlarr-sonarr-readarr-and-radarr)
+- [PaperlessNG](#paperlessng)
+- [Ping](#ping)
+- [Prometheus](#prometheus)
+- [AdGuard Home](#adguard-home)
+- [Portainer](#portainer)
+- [Emby / Jellyfin](#emby--jellyfin)
+- [Uptime Kuma](#uptime-kuma)
+- [Tautulli](#tautulli)
+- [Mealie](#mealie)
+- [Healthchecks](#healthchecks)
+- [Proxmox](#proxmox)
+- [rTorrent](#rtorrent)
+- [qBittorrent](#qbittorrent)
+- [CopyToClipboard](#copy-to-clipboard)
+- [Speedtest Tracker](#SpeedtestTracker)
+- [What's Up Docker](#whats-up-docker)
+- [SABnzbd](#sabnzbd)
+- [OctoPrint](#octoprint)
+- [Tdarr](#tdarr)
+- [PiAlert](#pialert)
+- [Immich](#immich)
+- [OpenHAB](#openhab)
+- [Jellystat](#jellystat)
+- [Home Assistant](#home-assistant)
 
-If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
+> [!IMPORTANT]  
+> Using smart cards will probably requires
+> If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md#my-service-card-doesnt-work-nothing-appears-or-offline-status-is-displayed-pi-hole-sonarr-ping-) page.
 
 ## Common options
 
@@ -162,7 +166,7 @@ For Prometheus you need to set the type to Prometheus and provide a url.
 ```
 
 ## AdGuard Home
-For AdGuard Home you need to set the type to AdGuard, if you have somes issues as 403 responses on requests you need to provide authentification in headers for locations needed as below.
+For AdGuard Home you need to set the type to AdGuard, if you have some issues as 403 responses on requests you need to provide authentication in headers for locations needed as below.
 
 ```yaml
 - name: "Adguard"
@@ -291,7 +295,7 @@ servers can be found at https://enable-cors.org/server.html.
 
 This service displays status information of a Proxmox node (VMs running and disk, memory and cpu used). It uses the proxmox API and [API Tokens](https://pve.proxmox.com/pve-docs/pveum-plain.html) for authorization so you need to generate one to set in the yaml config. You can set it up in Proxmox under Permissions > API Tokens. You also need to know the realm the user of the API Token is assigned to (by default pam).
 
-The API Token (or the user asigned to that token if not separated permissions is checked) are this:
+The API Token (or the user assigned to that token if not separated permissions is checked) are this:
 
 | Path               | Permission | Comments                                                          |
 |--------------------|------------|-------------------------------------------------------------------|
@@ -467,7 +471,7 @@ To enable cors on OpenHAB, edit your services/runtime.cfg and uncomment or add t
 
 ## Jellystat
 
-The Jellystat serice display the number of concurrent streams on your jellyfin server.
+The Jellystat service display the number of concurrent streams on your jellyfin server.
 The Jellystat server must be running behind a reverse proxy to add some cors headers:
  - Access-Control-Allow-Origin: ${your_domain}
  - Access-Control-Allow-Headers: Authorization