From 79d8d0707b80185fc47203184f39bb670f7f7cf6 Mon Sep 17 00:00:00 2001
From: Johannes Kirschbauer <hsjobeki@gmail.com>
Date: Tue, 8 Jul 2025 10:06:22 +0200
Subject: [PATCH] Templates/default/modules/gnome: Add doc-comment - what the
 module does, how to use it

---
 templates/clan/default/modules/gnome.nix | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/templates/clan/default/modules/gnome.nix b/templates/clan/default/modules/gnome.nix
index bcbc5a148..b4f77768d 100644
--- a/templates/clan/default/modules/gnome.nix
+++ b/templates/clan/default/modules/gnome.nix
@@ -1,3 +1,17 @@
+/*
+  This is an example of a simple nixos module:
+
+  Enables the GNOME desktop environment and the GDM display manager.
+
+  To use this module, import it in your machines NixOS configuration like this:
+
+  ```nix
+  imports = [
+    modules/gnome.nix
+  ];
+  ```
+*/
+{ ... }:
 {
   services.xserver.enable = true;
   services.xserver.desktopManager.gnome.enable = true;