From 8c91a210b296f79883d7c673029d7823a868ea09 Mon Sep 17 00:00:00 2001
From: alexion <contact@alexion.dev>
Date: Mon, 5 Oct 2026 00:13:31 -0400
Subject: [PATCH] docs(nixos): clarify registry option descriptions

---
 configs/nixos/registry/homepage.nix       | 12 ++++++------
 configs/nixos/registry/route.nix          |  8 ++++----
 configs/nixos/registry/shell-shortcut.nix |  4 ++--
 src/dotfiles/registry/schema.nix          |  8 ++++----
 4 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/configs/nixos/registry/homepage.nix b/configs/nixos/registry/homepage.nix
index 78926cb..8042368 100644
--- a/configs/nixos/registry/homepage.nix
+++ b/configs/nixos/registry/homepage.nix
@@ -5,40 +5,40 @@
       tab = lib.mkOption {
         type = lib.types.str;
         example = "Apps";
-        description = "Homepage tab that contains this entry.";
+        description = "Groups the entry in a Homepage tab.";
       };
 
       section = lib.mkOption {
         type = lib.types.str;
         example = "Media";
-        description = "Homepage section that contains this entry.";
+        description = "Groups the entry in a Homepage section.";
       };
 
       name = lib.mkOption {
         type = lib.types.str;
         example = "Navidrome";
-        description = "Homepage display name for this entry.";
+        description = "Sets the display name in Homepage.";
       };
 
       description = lib.mkOption {
         type = lib.types.nullOr lib.types.str;
         default = null;
         example = "Music";
-        description = "Homepage description for this entry.";
+        description = "Sets the description in Homepage.";
       };
 
       icon = lib.mkOption {
         type = lib.types.nullOr lib.types.str;
         default = null;
         example = "navidrome.png";
-        description = "Homepage icon for this entry.";
+        description = "Sets the icon in Homepage.";
       };
 
       href = lib.mkOption {
         type = lib.types.nullOr lib.types.str;
         default = null;
         example = "https://music.alexion.dev";
-        description = "Homepage link override for this entry.";
+        description = "Overrides the generated Homepage link.";
       };
     };
   };
diff --git a/configs/nixos/registry/route.nix b/configs/nixos/registry/route.nix
index 653ae31..0f74491 100644
--- a/configs/nixos/registry/route.nix
+++ b/configs/nixos/registry/route.nix
@@ -36,7 +36,7 @@
       domain = lib.mkOption {
         type = lib.types.str;
         example = "files.alexion.dev";
-        description = "Public domain for this route.";
+        description = "Records the public domain for this route.";
       };
 
       protocol = lib.mkOption {
@@ -45,14 +45,14 @@
           "https"
           "udp"
         ];
-        description = "Public protocol for this route.";
+        description = "Selects the public protocol for this route.";
       };
 
       port = lib.mkOption {
         type = lib.types.nullOr lib.types.port;
         default = null;
         example = 3923;
-        description = "HTTP backend port for an HTTP or HTTPS route.";
+        description = "Sets the HTTP backend port for an HTTP or HTTPS route.";
       };
 
       ports = lib.mkOption {
@@ -62,7 +62,7 @@
           2456
           2457
         ];
-        description = "UDP ports for a UDP route.";
+        description = "Sets the UDP ports for a UDP route.";
       };
     };
   };
diff --git a/configs/nixos/registry/shell-shortcut.nix b/configs/nixos/registry/shell-shortcut.nix
index c2a15c9..6f2bb54 100644
--- a/configs/nixos/registry/shell-shortcut.nix
+++ b/configs/nixos/registry/shell-shortcut.nix
@@ -6,13 +6,13 @@
         command = lib.mkOption {
           type = lib.types.str;
           example = "nvim";
-          description = "Command expanded by this shell shortcut.";
+          description = "Sets the command expanded by this shortcut.";
         };
 
         abbreviation = lib.mkOption {
           type = lib.types.bool;
           default = true;
-          description = "Whether fish realizes this shell shortcut as an abbreviation instead of an alias.";
+          description = "Uses a Fish abbreviation instead of an alias.";
         };
       };
     }
diff --git a/src/dotfiles/registry/schema.nix b/src/dotfiles/registry/schema.nix
index 0bdc521..1ebe88d 100644
--- a/src/dotfiles/registry/schema.nix
+++ b/src/dotfiles/registry/schema.nix
@@ -5,14 +5,14 @@ let
       assertion = lib.mkOption {
         type = lib.types.functionTo lib.types.bool;
         description = ''
-          Tests this registry's flattened collected entries.
+          Tests the registry's flattened entries.
         '';
       };
 
       message = lib.mkOption {
         type = lib.types.str;
         description = ''
-          Describes the registry validation failure.
+          Describes the validation failure.
         '';
       };
     };
@@ -23,7 +23,7 @@ in
     type = lib.mkOption {
       type = lib.types.raw;
       description = ''
-        Defines the NixOS option type for one registry entry.
+        Defines the NixOS option type for a registry entry.
       '';
     };
 
@@ -31,7 +31,7 @@ in
       type = lib.types.listOf checkType;
       default = [ ];
       description = ''
-        Contains validation checks for this registry's flattened collected entries.
+        Lists validation checks for the registry's flattened entries.
       '';
     };
   };