From abc78bac5771056194130b6615c484c87a1b4cec Mon Sep 17 00:00:00 2001 From: Qubasa Date: Fri, 25 Jul 2025 15:20:03 +0700 Subject: [PATCH 1/4] docs: Add a navigation footer button --- docs/mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ca867d620..6c333c6c9 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -197,6 +197,7 @@ theme: favicon: https://clan.lol/favicon.svg name: material features: + - navigation.footer - navigation.instant - navigation.tabs - navigation.tabs.sticky From 51b4b0b6478b40ca5b252e988e3554e6f0530a1d Mon Sep 17 00:00:00 2001 From: Qubasa Date: Fri, 25 Jul 2025 15:20:26 +0700 Subject: [PATCH 2/4] docs: FIx old nix symlinks not being cleaned up --- docs/nix/default.nix | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/nix/default.nix b/docs/nix/default.nix index 115a600c2..7fa13e06d 100644 --- a/docs/nix/default.nix +++ b/docs/nix/default.nix @@ -55,6 +55,7 @@ pkgs.stdenv.mkDerivation { chmod -R +w ./site/reference echo "Generated API documentation in './site/reference/' " + rm -r ./site/options-page || true cp -r ${docs-options} ./site/options-page chmod -R +w ./site/options-page From e1f57cd6186cdfcc75488f23af38ec37c826ab14 Mon Sep 17 00:00:00 2001 From: Qubasa Date: Fri, 25 Jul 2025 16:07:18 +0700 Subject: [PATCH 3/4] docs: Improve the documentation index page --- docs/site/index.md | 60 ++++++++++++++-------------------------------- 1 file changed, 18 insertions(+), 42 deletions(-) diff --git a/docs/site/index.md b/docs/site/index.md index 44081b7a9..5462de970 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -7,38 +7,39 @@ hide: # :material-home: What is Clan? [Clan](https://clan.lol/) is a peer-to-peer computer management framework that -empowers you to reclaim control over your digital computing experience. Built on -NixOS, Clan provides a unified interface for managing networks of machines with -automated [secret management](./guides/secrets.md), secure [mesh VPN -connectivity](./guides/mesh-vpn.md), and customizable installation images. Whether -you're running a homelab or building decentralized computing infrastructure, -Clan simplifies configuration management while restoring your independence from -closed computing ecosystems. +empowers you to **selfhost in a reliable and scalable way**. + +Built on NixOS, Clan provides a **declarative interface for managing machines** with automated [secret management](./guides/secrets.md), easy [mesh VPN +connectivity](./guides/mesh-vpn.md), and [automated backups](./reference/clanServices/borgbackup/). + +Whether you're running a homelab or maintaining critical computing infrastructure, +Clan will help **reduce maintainance burden** by allowing a **git repository to define your whole network** of computers. + +In combination with [sops-nix](https://github.com/Mic92/sops-nix), [nixos-anywhere](https://github.com/nix-community/nixos-anywhere) and [disko](https://github.com/nix-community/disko), Clan makes it possible to have **collaborative infrastructure**. At the heart of Clan are [Clan Services](./reference/clanServices/index.md) - the core concept that enables you to add functionality across multiple machines in your network. While Clan ships with essential core services, you can [create custom services](./guides/clanServices.md) tailored to your specific needs. -[Getting Started](./guides/getting-started/index.md){ .md-button } ## :material-book: Guides -**How-to Guides for achieving a certain goal or solving a specific issue.** +How-to Guides for achieving a certain goal or solving a specific issue.
-- [Create a Machine](./guides/getting-started/add-machines.md) +- [:material-clock-fast: Getting Started](./guides/getting-started) --- - How to create your first machine + Get started in less then 20 minutes! -- [macOS](./guides/macos.md) +- [Mac OS](./guides/macos.md) --- - How to manage macOS machines with nix-darwin + How to manage Mac OS machines with Clan - [Contribute](./guides/contributing/CONTRIBUTING.md) @@ -58,42 +59,17 @@ Explore the foundational ideas. --- - Learn about Generators + Learn about Generators, our way to secret management - [Inventory](./concepts/inventory.md) --- - Learn about Inventory + Learn about the Inventory, a multi machine Nix interface
-## API Reference -Technical reference for Clan's CLI and Nix modules +## Blog -
- -- [CLI Reference](./reference/cli/index.md) - - --- - - Command-line interface. - - Full reference for the `clan` CLI tool. - -- [Service Modules](./reference/clanServices/index.md) - - --- - - Overview of built-in service modules that provide composable functionality across machines. - -- [Core NixOS-module](./reference/clan.core/index.md) - - --- - - The foundation of Clan's functionality - - Reference for the `clan-core` NixOS module — automatically part of any machine to enable Clan's core features. - -
+Visit our [Clan Blog](https://clan.lol/blog/) for the latest updates, tutorials, and community stories. From cad7d2d95f5ad76dbfe8620763591c009d185cdb Mon Sep 17 00:00:00 2001 From: Qubasa Date: Fri, 25 Jul 2025 16:10:32 +0700 Subject: [PATCH 4/4] docs: reword concepts description docs: fix build errors --- docs/site/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/site/index.md b/docs/site/index.md index 5462de970..957655aa3 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -10,7 +10,7 @@ hide: empowers you to **selfhost in a reliable and scalable way**. Built on NixOS, Clan provides a **declarative interface for managing machines** with automated [secret management](./guides/secrets.md), easy [mesh VPN -connectivity](./guides/mesh-vpn.md), and [automated backups](./reference/clanServices/borgbackup/). +connectivity](./guides/mesh-vpn.md), and [automated backups](./reference/clanServices/borgbackup.md). Whether you're running a homelab or maintaining critical computing infrastructure, Clan will help **reduce maintainance burden** by allowing a **git repository to define your whole network** of computers. @@ -29,7 +29,7 @@ How-to Guides for achieving a certain goal or solving a specific issue.
-- [:material-clock-fast: Getting Started](./guides/getting-started) +- [:material-clock-fast: Getting Started](./guides/getting-started/index.md) --- @@ -51,7 +51,7 @@ How-to Guides for achieving a certain goal or solving a specific issue. ## Concepts -Explore the foundational ideas. +Explore the underlying principles of Clan