docs: add section-by-section comments — __init__.py

ns8_backup_monitor/__init__.py

@@ -1,2 +1,23 @@
-# ns8-backup-monitor package
+"""ns8-backup-monitor — NethServer 8 backup failure notification service.
+
+This package receives Alertmanager webhook alerts for backup failures,
+correlates per-module status data stored in the NS8 cluster Redis, optionally
+verifies repository health via restic, and sends a detailed email notification
+through the NS8 mail relay (ns8-sendmail / runagent).
+
+Public API
+----------
+The package is executed as a module:
+    python3 -m ns8_backup_monitor [--config PATH]
+
+Submodules
+----------
+receiver    HTTP webhook server; entry point for Alertmanager payloads.
+correlator  Reads Redis state and classifies the backup outcome.
+repo_check  Probes restic repositories for reachability and integrity.
+notifier    Builds HTML/text emails and dispatches them via ns8-sendmail.
+utils       Configuration loader and logging setup shared by all modules.
+"""
+
+# Package version — updated on every release.
 __version__ = "0.1.0"