From cff445229deefd38b481187c655f21abcbe1bacf Mon Sep 17 00:00:00 2001
From: Johannes Kirschbauer <hsjobeki@gmail.com>
Date: Thu, 10 Jul 2025 19:00:39 +0200
Subject: [PATCH] docs: fix user module prompt description

---
 clanServices/users/default.nix | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/clanServices/users/default.nix b/clanServices/users/default.nix
index d5e6c3447..8297be177 100644
--- a/clanServices/users/default.nix
+++ b/clanServices/users/default.nix
@@ -20,7 +20,19 @@
             type = lib.types.bool;
             default = true;
             example = false;
-            description = "Whether the user should be prompted.";
+            description = ''
+              Whether the user should be prompted for a password.
+
+              Effects:
+
+              - *enabled* (`true`) - Prompt for a passwort during the machine installation or update workflow.
+              - *disabled* (`false`) - Generate a passwort during the machine installation or update workflow.
+
+              The password can be shown in two steps:
+
+              - `clan vars list <machine-name>`
+              - `clan vars get <machine-name> <name-of-password-variable>`
+            '';
           };
         };
       };