Merge pull request 'docs: set manifest.readme for services to include README in the docs' (#4294) from push-rlukssmkxtky into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4294
This commit is contained in:
Michael Hoang
2025-07-10 03:00:36 +00:00
5 changed files with 6 additions and 1 deletions

View File

@@ -4,6 +4,7 @@
manifest.name = "clan-core/emergency-access"; manifest.name = "clan-core/emergency-access";
manifest.description = "Set recovery password for emergency access to machine"; manifest.description = "Set recovery password for emergency access to machine";
manifest.categories = [ "System" ]; manifest.categories = [ "System" ];
manifest.readme = builtins.readFile ./README.md;
roles.default.perInstance = { roles.default.perInstance = {
nixosModule = nixosModule =

View File

@@ -7,6 +7,7 @@
"System" "System"
"Network" "Network"
]; ];
manifest.readme = builtins.readFile ./README.md;
roles.client = { roles.client = {
interface = interface =

View File

@@ -4,6 +4,7 @@
manifest.name = "clan-core/state-version"; manifest.name = "clan-core/state-version";
manifest.description = "Automatically generate the state version of the nixos installation."; manifest.description = "Automatically generate the state version of the nixos installation.";
manifest.categories = [ "System" ]; manifest.categories = [ "System" ];
manifest.readme = builtins.readFile ./README.md;
roles.default = { roles.default = {
@@ -24,7 +25,7 @@
warnings = [ warnings = [
'' ''
The clan.state-version service is deprecated and will be 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. Please migrate your configuration to use `clan.core.settings.state-version.enable = true` instead.
'' ''

View File

@@ -4,6 +4,7 @@
manifest.name = "clan-core/trusted-nix-caches"; 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.description = "This module sets the `clan.lol` and `nix-community` cache up as a trusted cache.";
manifest.categories = [ "System" ]; manifest.categories = [ "System" ];
manifest.readme = builtins.readFile ./README.md;
roles.default = { roles.default = {

View File

@@ -4,6 +4,7 @@
manifest.name = "clan-core/users"; manifest.name = "clan-core/users";
manifest.description = "Automatically generates and configures a password for the specified user account."; manifest.description = "Automatically generates and configures a password for the specified user account.";
manifest.categories = [ "System" ]; manifest.categories = [ "System" ];
manifest.readme = builtins.readFile ./README.md;
roles.default = { roles.default = {
interface = interface =