Merge pull request 'Move developer guides to the "Developer" section' (#4462) from Qubasa/clan-core:dev_docs into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4462

docs/mkdocs.yml

@@ -48,34 +48,25 @@ nav:
   - Home: index.md
   - Guides:
       - Getting Started:
-          - 🚀 Creating Your First Clan: guides/getting-started/index.md
-          - 📀 Create USB Installer (optional): guides/getting-started/installer.md
-          - ⚙️ Add Machines: guides/getting-started/add-machines.md
-          - ⚙️ Add User: guides/getting-started/add-user.md
-          - ⚙️ Add Services: guides/getting-started/add-services.md
-          - 🚢 Deploy Machine: guides/getting-started/deploy.md
-          - 🧪 Continuous Integration: guides/getting-started/check.md
-      - clanServices: guides/clanServices.md
-      - Disk Encryption: guides/disk-encryption.md
-      - Mesh VPN: guides/mesh-vpn.md
+          - Creating Your First Clan: guides/getting-started/index.md
+          - Create USB Installer: guides/getting-started/installer.md
+          - Add Machines: guides/getting-started/add-machines.md
+          - Add User: guides/getting-started/add-user.md
+          - Add Services: guides/getting-started/add-services.md
+          - Deploy Machine: guides/getting-started/deploy.md
+          - Continuous Integration: guides/getting-started/check.md
+      - Inventory: guides/inventory.md
+      - Using Services: guides/clanServices.md
       - Backup & Restore: guides/backups.md
+      - Disk Encryption: guides/disk-encryption.md
       - Vars: guides/vars-backend.md
       - Age Plugins: guides/age-plugins.md
-      - Secrets (Advanced Usage): guides/secrets.md
-      - Adding more machines: guides/more-machines.md
+      - Advanced Secrets: guides/secrets.md
+      - Machine Autoincludes: guides/more-machines.md
       - Target Host: guides/target-host.md
-      - Inventory:
-          - Inventory: guides/inventory.md
+      - Zerotier VPN: guides/mesh-vpn.md
       - Secure Boot: guides/secure-boot.md
       - Flake-parts: guides/flake-parts.md
-      - Authoring:
-          - clanService: guides/authoring/clanServices/index.md
-          - Disk Template: guides/authoring/templates/disk/disko-templates.md
-          - clanModule: guides/authoring/clanModules/index.md
-      - Contributing:
-          - Contribute: guides/contributing/CONTRIBUTING.md
-          - Debugging: guides/contributing/debugging.md
-          - Testing: guides/contributing/testing.md
       - Migrations:
           - Migrate existing Flakes: guides/migrations/migration-guide.md
           - Migrate inventory Services: guides/migrations/migrate-inventory-services.md
@@ -85,66 +76,84 @@ nav:
   - Reference:
       - Overview: reference/index.md
       - Services:
-          - Overview: reference/clanServices/index.md
-          - reference/clanServices/admin.md
-          - reference/clanServices/borgbackup.md
-          - reference/clanServices/data-mesher.md
-          - reference/clanServices/emergency-access.md
-          - reference/clanServices/garage.md
-          - reference/clanServices/hello-world.md
-          - reference/clanServices/importer.md
-          - reference/clanServices/mycelium.md
-          - reference/clanServices/packages.md
-          - reference/clanServices/sshd.md
-          - reference/clanServices/state-version.md
-          - reference/clanServices/trusted-nix-caches.md
-          - reference/clanServices/users.md
-          - reference/clanServices/wifi.md
-          - reference/clanServices/zerotier.md
-      - Interface for making Services: reference/clanServices/clan-service-author-interface.md
+          - List:
+              - Overview: reference/clanServices/index.md
+              - reference/clanServices/admin.md
+              - reference/clanServices/borgbackup.md
+              - reference/clanServices/data-mesher.md
+              - reference/clanServices/emergency-access.md
+              - reference/clanServices/garage.md
+              - reference/clanServices/hello-world.md
+              - reference/clanServices/importer.md
+              - reference/clanServices/mycelium.md
+              - reference/clanServices/packages.md
+              - reference/clanServices/sshd.md
+              - reference/clanServices/state-version.md
+              - reference/clanServices/trusted-nix-caches.md
+              - reference/clanServices/users.md
+              - reference/clanServices/wifi.md
+              - reference/clanServices/zerotier.md
+          - API: reference/clanServices/clan-service-author-interface.md
+          - Writing a Service Module: developer/extensions/clanServices/index.md
       - Modules:
-          - Overview: reference/clanModules/index.md
-          - reference/clanModules/frontmatter/index.md
-          # TODO: display the docs of the clan.service modules
-          - reference/clanModules/admin.md
-          # This is the module overview and should stay at the top
-          - reference/clanModules/borgbackup-static.md
-          - reference/clanModules/data-mesher.md
-          - reference/clanModules/borgbackup.md
-          - reference/clanModules/deltachat.md
-          - reference/clanModules/disk-id.md
-          - reference/clanModules/dyndns.md
-          - reference/clanModules/ergochat.md
-          - reference/clanModules/garage.md
-          - reference/clanModules/heisenbridge.md
-          - reference/clanModules/importer.md
-          - reference/clanModules/iwd.md
-          - reference/clanModules/localbackup.md
-          - reference/clanModules/localsend.md
-          - reference/clanModules/matrix-synapse.md
-          - reference/clanModules/moonlight.md
-          - reference/clanModules/mumble.md
-          - reference/clanModules/mycelium.md
-          - reference/clanModules/nginx.md
-          - reference/clanModules/packages.md
-          - reference/clanModules/postgresql.md
-          - reference/clanModules/root-password.md
-          - reference/clanModules/single-disk.md
-          - reference/clanModules/sshd.md
-          - reference/clanModules/state-version.md
-          - reference/clanModules/static-hosts.md
-          - reference/clanModules/sunshine.md
-          - reference/clanModules/syncthing-static-peers.md
-          - reference/clanModules/syncthing.md
-          - reference/clanModules/thelounge.md
-          - reference/clanModules/trusted-nix-caches.md
-          - reference/clanModules/user-password.md
-          - reference/clanModules/auto-upgrade.md
-          - reference/clanModules/vaultwarden.md
-          - reference/clanModules/xfce.md
-          - reference/clanModules/zerotier-static-peers.md
-          - reference/clanModules/zerotier.md
-          - reference/clanModules/zt-tcp-relay.md
+          - List:
+              - Overview: reference/clanModules/index.md
+              - reference/clanModules/frontmatter/index.md
+              # TODO: display the docs of the clan.service modules
+              - reference/clanModules/admin.md
+              # This is the module overview and should stay at the top
+              - reference/clanModules/borgbackup-static.md
+              - reference/clanModules/data-mesher.md
+              - reference/clanModules/borgbackup.md
+              - reference/clanModules/deltachat.md
+              - reference/clanModules/disk-id.md
+              - reference/clanModules/dyndns.md
+              - reference/clanModules/ergochat.md
+              - reference/clanModules/garage.md
+              - reference/clanModules/heisenbridge.md
+              - reference/clanModules/importer.md
+              - reference/clanModules/iwd.md
+              - reference/clanModules/localbackup.md
+              - reference/clanModules/localsend.md
+              - reference/clanModules/matrix-synapse.md
+              - reference/clanModules/moonlight.md
+              - reference/clanModules/mumble.md
+              - reference/clanModules/mycelium.md
+              - reference/clanModules/nginx.md
+              - reference/clanModules/packages.md
+              - reference/clanModules/postgresql.md
+              - reference/clanModules/root-password.md
+              - reference/clanModules/single-disk.md
+              - reference/clanModules/sshd.md
+              - reference/clanModules/state-version.md
+              - reference/clanModules/static-hosts.md
+              - reference/clanModules/sunshine.md
+              - reference/clanModules/syncthing-static-peers.md
+              - reference/clanModules/syncthing.md
+              - reference/clanModules/thelounge.md
+              - reference/clanModules/trusted-nix-caches.md
+              - reference/clanModules/user-password.md
+              - reference/clanModules/auto-upgrade.md
+              - reference/clanModules/vaultwarden.md
+              - reference/clanModules/xfce.md
+              - reference/clanModules/zerotier-static-peers.md
+              - reference/clanModules/zerotier.md
+              - reference/clanModules/zt-tcp-relay.md
+          - Writing a Clan Module: developer/extensions/clanModules/index.md
+
+      - Nix API:
+          - inputs.clan-core.lib.clan: reference/nix-api/clan.md
+          - config.clan.core:
+              - Overview: reference/clan.core/index.md
+              - reference/clan.core/backups.md
+              - reference/clan.core/deployment.md
+              - reference/clan.core/facts.md
+              - reference/clan.core/networking.md
+              - reference/clan.core/settings.md
+              - reference/clan.core/sops.md
+              - reference/clan.core/state.md
+              - reference/clan.core/vars.md
+          - Inventory: reference/nix-api/inventory.md
       - CLI:
           - Overview: reference/cli/index.md
 
@@ -161,21 +170,7 @@ nav:
           - reference/cli/templates.md
           - reference/cli/vars.md
           - reference/cli/vms.md
-      - NixOS Modules:
-          - clan.core:
-              - Overview: reference/clan.core/index.md
 
-              - reference/clan.core/backups.md
-              - reference/clan.core/deployment.md
-              - reference/clan.core/facts.md
-              - reference/clan.core/networking.md
-              - reference/clan.core/settings.md
-              - reference/clan.core/sops.md
-              - reference/clan.core/state.md
-              - reference/clan.core/vars.md
-      - Nix API:
-          - clan: reference/nix-api/clan.md
-          - Inventory: reference/nix-api/inventory.md
       - Glossary: reference/glossary.md
       - Decisions:
           - Architecture Decisions: decisions/README.md
@@ -187,8 +182,14 @@ nav:
           - Template: decisions/_template.md
   - Options: options.md
   - Developer:
-      - Introduction: intern/index.md
-      - API: intern/api.md
+      - Introduction: developer/index.md
+      - Dev Setup: developer/contributing/CONTRIBUTING.md
+      - Writing a Service Module: developer/extensions/clanServices/index.md
+      - Writing a Clan Module: developer/extensions/clanModules/index.md
+      - Writing a Disko Template: developer/extensions/templates/disk/disko-templates.md
+      - Debugging: developer/contributing/debugging.md
+      - Testing: developer/contributing/testing.md
+      - Python API: developer/api.md
 
 docs_dir: site
 site_dir: out

docs/nix/render_options/__init__.py

@@ -805,7 +805,7 @@ Typically needed by module authors to define roles, behavior and metadata for di
 !!! Note
     This is not a user-facing documentation, but rather meant as a reference for *module authors*
 
-    See: [clanService Authoring Guide](../../guides/authoring/clanServices/index.md)
+    See: [clanService Authoring Guide](../../developer/extensions/clanServices/index.md)
 """
     # Inventory options are already included under the clan attribute
     # We just omitted them in the clan docs, because we want a separate output for the inventory model

docs/site/developer/extensions/clanServices/index.md

@@ -267,5 +267,5 @@ The benefit of this approach is that downstream users can override the value of
 ## Further
 
 - [Reference Documentation for Service Authors](../../../reference/clanServices/clan-service-author-interface.md)
-- [Migration Guide from ClanModules to ClanServices](../../migrations/migrate-inventory-services.md)
+- [Migration Guide from ClanModules to ClanServices](../../../guides/migrations/migrate-inventory-services.md)
 - [Decision that lead to ClanServices](../../../decisions/01-ClanModules.md)

docs/site/guides/clanServices.md

@@ -138,7 +138,7 @@ You can use services exposed by Clan’s core module library, `clan-core`.
 
 You can also author your own `clanService` modules.
 
-🔗 Learn how to write your own service: [Authoring a clanService](../guides/authoring/clanServices/index.md)
+🔗 Learn how to write your own service: [Authoring a clanService](../developer/extensions/clanServices/index.md)
 
 You might expose your service module from your flake — this makes it easy for other people to also use your module in their clan.
 
@@ -154,6 +154,6 @@ You might expose your service module from your flake — this makes it easy for
 
 ## What’s Next?
 
-* [Author your own clanService →](../guides/authoring/clanServices/index.md)
+* [Author your own clanService →](../developer/extensions/clanServices/index.md)
 * [Migrate from clanModules →](../guides/migrations/migrate-inventory-services.md)
 <!-- TODO: * [Understand the architecture →](../explanation/clan-architecture.md) -->

docs/site/guides/getting-started/add-services.md

@@ -41,7 +41,7 @@ To learn more: [Guide about clanService](../clanServices.md)
 ```
 
 1. See [reference/clanServices](../../reference/clanServices/index.md) for all available services and how to configure them.
-   Or read [authoring/clanServices](../authoring/clanServices/index.md) if you want to bring your own
+   Or read [authoring/clanServices](../../developer/extensions/clanServices/index.md) if you want to bring your own
 
 2. Replace `__YOUR_CONTROLLER_` with the *name* of your machine.
 

docs/site/guides/getting-started/index.md

@@ -125,7 +125,7 @@ To change the name of your clan edit `meta.name` in the `clan.nix` or `flake.nix
 You can continue with **any** of the following steps at your own pace:
 
 - [x] [Install Nix & Clan CLI](./index.md)
-- [x] [Initialize Clan](./index.md#initialize-your-project)
+- [x] [Initialize Clan](./index.md#add-clan-cli-to-your-shell)
 - [ ] [Create USB Installer (optional)](./installer.md)
 - [ ] [Add Machines](./add-machines.md)
 - [ ] [Add a User](./add-user.md)

docs/site/guides/migrations/migrate-inventory-services.md

@@ -1,7 +1,7 @@
 # Migrating from using `clanModules` to `clanServices`
 
 **Audience**: This is a guide for **people using `clanModules`**.
-If you are a **module author** and need to migrate your modules please consult our **new** [clanServices authoring guide](../authoring/clanServices/index.md)
+If you are a **module author** and need to migrate your modules please consult our **new** [clanServices authoring guide](../../developer/extensions/clanServices/index.md)
 
 ## What's Changing?
 
@@ -329,6 +329,6 @@ instances = {
 
 ## Further reference
 
-* [Authoring a 'clan.service' module](../authoring/clanServices/index.md)
+* [Authoring a 'clan.service' module](../../developer/extensions/clanServices/index.md)
 * [ClanServices](../clanServices.md)
 * [Inventory Reference](../../reference/nix-api/inventory.md)

docs/site/index.md

@@ -38,7 +38,7 @@ hide:
 
     Use Clan with [https://flake.parts/]()
 
--   [Contribute](./guides/contributing/CONTRIBUTING.md)
+-   [Contribute](./developer/contributing/CONTRIBUTING.md)
 
     ---
 

lib/modules/inventoryClass/interface.nix

@@ -142,7 +142,7 @@ in
             - The module MUST have at least `features = [ "inventory" ]` in the frontmatter section.
             - The module MUST have a subfolder `roles` with at least one `{roleName}.nix` file.
 
-            For further information see: [Module Authoring Guide](../../guides/authoring/clanServices/index.md).
+            For further information see: [Module Authoring Guide](../../developer/extensions/clanServices/index.md).
 
         ???+ example
             ```nix
@@ -179,8 +179,8 @@ in
               map (m: "'${m}'") (lib.attrNames (lib.filterAttrs (n: _v: !builtins.elem n allowedNames) moduleSet))
             )}
 
-            See: https://docs.clan.lol/guides/clanServices/
-            And: https://docs.clan.lol/guides/authoring/clanServices/
+            See: https://docs.clan.lol/developer/extensions/clanServices/
+            And: https://docs.clan.lol/developer/extensions/clanServices/
           '' moduleSet;
     };