Docs: add top-level index, refactor according to diataxis

docs/site/manual/flake-parts.md

@@ -0,0 +1,97 @@
+# Clan with `flake-parts`
+
+Clan supports integration with [flake.parts](https://flake.parts/) a tool which allows composing nixos modules in a modular way.
+
+Here's how to set up Clan using `nix flakes` and `flake-parts`.
+
+## 1. Update Your Flake Inputs
+
+To begin, you'll need to add `flake-parts` as a new dependency in your flake's inputs. This is alongside the already existing dependencies, such as `clan-core` and `nixpkgs`. Here's how you can update your `flake.nix` file:
+
+```nix
+# flake.nix
+inputs = {
+  nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
+
+  # New flake-parts input
+  flake-parts.url = "github:hercules-ci/flake-parts";
+  flake-parts.inputs.nixpkgs-lib.follows = "nixpkgs";
+
+  clan-core = {
+    url = "git+https://git.clan.lol/clan/clan-core";
+    inputs.nixpkgs.follows = "nixpkgs"; # Needed if your configuration uses nixpkgs unstable.
+    # New
+    inputs.flake-parts.follows = "flake-parts";
+  };
+}
+```
+
+## 2. Import Clan-Core Flake Module
+
+After updating your flake inputs, the next step is to import the `clan-core` flake module. This will make the [clan options](https://git.clan.lol/clan/clan-core/src/branch/main/flakeModules/clan.nix) available within `mkFlake`.
+
+```nix
+  outputs =
+    inputs@{ flake-parts, ... }:
+    flake-parts.lib.mkFlake { inherit inputs; } (
+      {
+        #
+        imports = [
+          inputs.clan-core.flakeModules.default
+        ];
+      }
+    );
+```
+
+### 3. Configure Clan Settings and Define Machines
+
+Configure your clan settings and define machine configurations.
+
+Below is a guide on how to structure this in your flake.nix:
+
+```nix
+  outputs = inputs@{ flake-parts, clan-core, ... }:
+    flake-parts.lib.mkFlake { inherit inputs; } ({self, pkgs, ...}: {
+      # We define our own systems below. you can still use this to add system specific outputs to your flake.
+      # See: https://flake.parts/getting-started
+      systems = [];
+
+      # import clan-core modules
+      imports = [
+        clan-core.flakeModules.default
+      ];
+      # Define your clan
+      clan = {
+        # Clan wide settings. (Required)
+        meta.name = ""; # Ensure to choose a unique name.
+
+        machines = {
+          jon = {
+            imports = [
+              ./machines/jon/configuration.nix
+              ./modules/disko.nix
+              # ... more modules
+            ];
+            nixpkgs.hostPlatform = "x86_64-linux";
+
+            # Set this for clan commands use ssh i.e. `clan machines update`
+            clan.core.networking.targetHost = pkgs.lib.mkDefault "root@jon";
+
+            # remote> lsblk --output NAME,ID-LINK,FSTYPE,SIZE,MOUNTPOINT
+            disko.devices.disk.main = {
+              device = "/dev/disk/by-id/nvme-eui.e8238fa6bf530001001b448b4aec2929";
+            };
+
+            # There needs to be exactly one controller per clan
+            clan.core.networking.zerotier.controller.enable = true;
+
+          };
+        };
+      };
+    });
+```
+
+For detailed information about configuring `flake-parts` and the available options within Clan,
+refer to the Clan module documentation located [here](https://git.clan.lol/clan/clan-core/src/branch/main/flakeModules/clan.nix).
+
+---

docs/site/manual/index.md

@@ -1,11 +1,34 @@
-# Manual
+# :material-book: Manual
 
-Explore the Clan Framework in detail with comprehensive information on specific topics:
+Instructions and explanations for practical Implementations ordered by Topics.
+
+## Tutorials
+
+**Learning-oriented adventures with a hands-on experience.**
+
+<div class="grid cards" markdown>
+
+-   :material-clock-fast:{ .lg .middle } __Set up in 15 minutes__
+
+    ---
+
+    Create your own clan and get everything
+    running in minutes
+
+    [:octicons-arrow-right-24: Getting started](../getting-started/index.md)
+
+</div>
+
+## Guides
+
+**How-to Guides for achieving a certain goal or solving a specific issue.**
 
 - [Include Machines](./include-machines.md): Learn how Clan automatically includes machines and Nix files.
 
-- [Secrets](./secrets.md): Learn how you can manage secrets
+- [Secrets](./secrets.md): Learn how to manage secrets.
 
-- [Inventory](./inventory.md): Access a distributed and editable version of the NixOS module system.
+- [Inventory](./inventory.md): Distributed and editable version of the NixOS module system.
 
-- [Contribute](./contribute.md): Discover how to set up a development environment to contribute to Clan!
+- [Flake-parts guide](./flake-parts.md): Use clan with [flake-parts](https://flake.parts/).
+
+- [Contribute](./contribute.md): Discover how to set up a development environment to contribute to Clan!