Merge pull request 'Improve landing page for docs, re-enable footer navigation' (#4491) from Qubasa/clan-core:improv_docs into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4491
This commit is contained in:
Luis Hebendanz
2025-07-25 09:32:44 +00:00
3 changed files with 21 additions and 43 deletions

View File

@@ -197,6 +197,7 @@ theme:
favicon: https://clan.lol/favicon.svg favicon: https://clan.lol/favicon.svg
name: material name: material
features: features:
- navigation.footer
- navigation.instant - navigation.instant
- navigation.tabs - navigation.tabs
- navigation.tabs.sticky - navigation.tabs.sticky

View File

@@ -55,6 +55,7 @@ pkgs.stdenv.mkDerivation {
chmod -R +w ./site/reference chmod -R +w ./site/reference
echo "Generated API documentation in './site/reference/' " echo "Generated API documentation in './site/reference/' "
rm -r ./site/options-page || true
cp -r ${docs-options} ./site/options-page cp -r ${docs-options} ./site/options-page
chmod -R +w ./site/options-page chmod -R +w ./site/options-page

View File

@@ -7,38 +7,39 @@ hide:
# :material-home: What is Clan? # :material-home: What is Clan?
[Clan](https://clan.lol/) is a peer-to-peer computer management framework that [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 empowers you to **selfhost in a reliable and scalable way**.
NixOS, Clan provides a unified interface for managing networks of machines with
automated [secret management](./guides/secrets.md), secure [mesh VPN 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 customizable installation images. Whether connectivity](./guides/mesh-vpn.md), and [automated backups](./reference/clanServices/borgbackup.md).
you're running a homelab or building decentralized computing infrastructure,
Clan simplifies configuration management while restoring your independence from Whether you're running a homelab or maintaining critical computing infrastructure,
closed computing ecosystems. 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 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 concept that enables you to add functionality across multiple machines in your
network. While Clan ships with essential core services, you can [create custom network. While Clan ships with essential core services, you can [create custom
services](./guides/clanServices.md) tailored to your specific needs. services](./guides/clanServices.md) tailored to your specific needs.
[Getting Started](./guides/getting-started/index.md){ .md-button }
## :material-book: Guides ## :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.
<div class="grid cards" markdown> <div class="grid cards" markdown>
- [Create a Machine](./guides/getting-started/add-machines.md) - [:material-clock-fast: Getting Started](./guides/getting-started/index.md)
--- ---
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) - [Contribute](./guides/contributing/CONTRIBUTING.md)
@@ -50,7 +51,7 @@ services](./guides/clanServices.md) tailored to your specific needs.
## Concepts ## Concepts
Explore the foundational ideas. Explore the underlying principles of Clan
<div class="grid cards" markdown> <div class="grid cards" markdown>
@@ -58,42 +59,17 @@ Explore the foundational ideas.
--- ---
Learn about Generators Learn about Generators, our way to secret management
- [Inventory](./concepts/inventory.md) - [Inventory](./concepts/inventory.md)
--- ---
Learn about Inventory Learn about the Inventory, a multi machine Nix interface
</div> </div>
## API Reference
Technical reference for Clan's CLI and Nix modules ## Blog
<div class="grid cards" markdown> Visit our [Clan Blog](https://clan.lol/blog/) for the latest updates, tutorials, and community stories.
- [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.
</div>