Reapply "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."

This reverts commit b19beb8913.
This commit is contained in:
Qubasa
2025-01-18 10:00:56 +07:00
parent b19beb8913
commit 0d2ee39746
19 changed files with 126 additions and 192 deletions

View File

@@ -1,4 +1,3 @@
# Adding Machines
Clan has two general methods of adding machines:
@@ -18,6 +17,18 @@ Every folder `machines/{machineName}` will be registered automatically as a Clan
- [x] `machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/)
- [x] `machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md).
## Automatic Imports
The `buildClan` function will automatically import modules if a directory named `<CLAN_ROOT>/imports` exists within the Clan. Below are the conditions for importing inventory modules:
- **Inventory Modules**: Modules located in `<CLAN_ROOT>/imports/inventory` will be automatically imported. Note that only inventory-compatible modules can be used in this location. To be compatible, a module must contain a `roles` folder.
- **Adding a Module**: To add a module, such as `mymodule`, create a dedicated directory at `<CLAN_ROOT>/imports/inventory/mymodule`, ensuring that it includes a `roles` folder.
For further details on creating Clan modules, please refer to the [Authoring Clan Modules](../clanmodules/index.md) section.
## Manual declaration
Machines can also be added manually under `buildClan`, `clan.*` in flake-parts or via [`inventory`](../manual/inventory.md).