From 957598e4491ce009d35a278351779ede16a6be97 Mon Sep 17 00:00:00 2001
From: Michael Hoang <enzime@users.noreply.github.com>
Date: Thu, 10 Jul 2025 12:52:29 +1000
Subject: [PATCH] docs: set `manifest.readme` for services to include README in
 the docs

---
 clanServices/emergency-access/default.nix   | 1 +
 clanServices/sshd/default.nix               | 1 +
 clanServices/state-version/default.nix      | 3 ++-
 clanServices/trusted-nix-caches/default.nix | 1 +
 clanServices/users/default.nix              | 1 +
 5 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/clanServices/emergency-access/default.nix b/clanServices/emergency-access/default.nix
index 81fce2d1c..14d69978c 100644
--- a/clanServices/emergency-access/default.nix
+++ b/clanServices/emergency-access/default.nix
@@ -4,6 +4,7 @@
   manifest.name = "clan-core/emergency-access";
   manifest.description = "Set recovery password for emergency access to machine";
   manifest.categories = [ "System" ];
+  manifest.readme = builtins.readFile ./README.md;
 
   roles.default.perInstance = {
     nixosModule =
diff --git a/clanServices/sshd/default.nix b/clanServices/sshd/default.nix
index 799358969..577bf1b8b 100644
--- a/clanServices/sshd/default.nix
+++ b/clanServices/sshd/default.nix
@@ -7,6 +7,7 @@
     "System"
     "Network"
   ];
+  manifest.readme = builtins.readFile ./README.md;
 
   roles.client = {
     interface =
diff --git a/clanServices/state-version/default.nix b/clanServices/state-version/default.nix
index ef7a90fa1..b855c645b 100644
--- a/clanServices/state-version/default.nix
+++ b/clanServices/state-version/default.nix
@@ -4,6 +4,7 @@
   manifest.name = "clan-core/state-version";
   manifest.description = "Automatically generate the state version of the nixos installation.";
   manifest.categories = [ "System" ];
+  manifest.readme = builtins.readFile ./README.md;
 
   roles.default = {
 
@@ -24,7 +25,7 @@
             warnings = [
               ''
                 The clan.state-version service is deprecated and will be
-                removed on 2025-07-15 in favor of a nix option. 
+                removed on 2025-07-15 in favor of a nix option.
 
                 Please migrate your configuration to use `clan.core.settings.state-version.enable = true` instead.
               ''
diff --git a/clanServices/trusted-nix-caches/default.nix b/clanServices/trusted-nix-caches/default.nix
index 3a04bb49a..ec8bab13f 100644
--- a/clanServices/trusted-nix-caches/default.nix
+++ b/clanServices/trusted-nix-caches/default.nix
@@ -4,6 +4,7 @@
   manifest.name = "clan-core/trusted-nix-caches";
   manifest.description = "This module sets the `clan.lol` and `nix-community` cache up as a trusted cache.";
   manifest.categories = [ "System" ];
+  manifest.readme = builtins.readFile ./README.md;
 
   roles.default = {
 
diff --git a/clanServices/users/default.nix b/clanServices/users/default.nix
index 80baf2c60..d5e6c3447 100644
--- a/clanServices/users/default.nix
+++ b/clanServices/users/default.nix
@@ -4,6 +4,7 @@
   manifest.name = "clan-core/users";
   manifest.description = "Automatically generates and configures a password for the specified user account.";
   manifest.categories = [ "System" ];
+  manifest.readme = builtins.readFile ./README.md;
 
   roles.default = {
     interface =