document networking.deploymentAddress

nixosModules/clanCore/networking.nix

@@ -7,6 +7,12 @@
 
         By default, the node's attribute name will be used.
         If set to null, only local deployment will be supported.
+
+        format: user@host:port&SSH_OPTION=SSH_VALUE
+        examples:
+          - machine.example.com
+          - user@machine2.example.com
+          - root@example.com:2222&IdentityFile=/path/to/private/key
       '';
       type = lib.types.nullOr lib.types.str;
       default = "root@${config.networking.hostName}";