Merge pull request 'hsjobeki-tutorials' (#1199) from hsjobeki-tutorials into main

.gitignore

@@ -11,6 +11,7 @@ result*
 /pkgs/clan-cli/clan_cli/webui/assets
 nixos.qcow2
 **/*.glade~
+/docs/out
 
 # python
 __pycache__

docs/.envrc

@@ -1,6 +1,6 @@
 source_up
 
-watch_file flake-module.nix shell.nix default.nix
+watch_file nix/flake-module.nix nix/shell.nix nix/default.nix
 
 # Because we depend on nixpkgs sources, uploading to builders takes a long time
 use flake .#docs --builders ''

docs/.gitignore

@@ -1,2 +0,0 @@
-# build oputputs
-site

docs/mkdocs.yml

@@ -9,8 +9,6 @@ validation:
   absolute_links: warn
   unrecognized_links: warn
 
-markdown_extensions:
-
 markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
@@ -41,7 +39,10 @@ nav:
       - Backup & Restore: getting-started/backups.md
       - Flake-parts: getting-started/flake-parts.md
   - Templates: templates/index.md
-  - Contributing: contributing.md
+  - Contributing: contributing/contributing.md
+
+docs_dir: site
+site_dir: out
 
 theme:
   logo: static/logo.png
@@ -72,8 +73,5 @@ theme:
         icon: material/weather-sunny
         name: Switch to light mode
 
-extra_css:
-  - stylesheets/extra.css
-
 plugins:
   - search

docs/nix/default.nix

@@ -2,7 +2,7 @@
 pkgs.stdenv.mkDerivation {
   name = "clan-documentation";
 
-  src = ./.;
+  src = ../.;
 
   nativeBuildInputs =
     [ pkgs.python3 ]

docs/site/contributing/contributing.md

@@ -0,0 +1 @@
+../../contributing.md

docs/site/getting-started/machines.md

@@ -16,7 +16,7 @@ This process involves preparing a suitable hardware and disk partitioning config
 
 === "**Physical Hardware**"
 
-    !!! How
+    !!! Steps
     
         1. Create a NixOS installer image and transfer it to a bootable USB drive as described in the [installer](./installer.md).
          
@@ -24,9 +24,9 @@ This process involves preparing a suitable hardware and disk partitioning config
 
 === "**Cloud Machines**"
 
-    !!! How
+    !!! Steps
 
-        Use any linux machine if it is reachable via SSH and supports `kexec`.
+        - Use any linux machine if it is reachable via SSH and supports `kexec`.
 
 Confirm the machine is reachable via SSH from your setup computer.
 
@@ -109,7 +109,9 @@ clan machines install my-machine <target_host>
 
 > Note: This may take a while for building and for the file transfer.
 
-#### 🎉 🚀 Your machine is all set up
+!!! success
+
+    Your machine is all set up. 🎉 🚀
 
 ---
 

flake.nix

@@ -40,7 +40,7 @@
           ./devShell.nix
           # TODO: migrate this @davHau
           # ./docs/flake-module
-          ./docs/flake-module.nix
+          ./docs/nix/flake-module.nix
           ./formatter.nix
           ./lib/flake-module.nix
           ./nixosModules/flake-module.nix