update some option descriptions

This commit is contained in:
greyweather committed 2026-09-03 13:56:37 +01:00
1 parent 6d8673ea1e
commit a5d0f522da
8 files changed
+21 -16

No files matched your search

+2 -1
View File
@@ -120,7 +120,7 @@ in {
in {
enable = lib.mkOption {
type = lib.types.bool;
description = "This option enables documentation for the flake, which is generated with Material for mkDocs and hosted by nginx at localhost:${defaultPort} by default.";
description = "Whether to enable documentation for the flake, generated with [Material for mkDocs](https://squidfunk.github.io/mkdocs-material/) and hosted by (containerised) nginx at localhost:${defaultPort} by default.";
default = true;
};
@@ -128,6 +128,7 @@ in {
type = lib.types.str;
description = "This option sets the port used by the nginx server hosting the local documentation site.";
default = defaultPort;
readOnly = true;
};
};
})) ];