From f91aca959f2b00c5e26b84f07f7acc0e9da96ff6 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Fri, 17 Oct 2025 09:27:17 +0200 Subject: [PATCH] docs: show {internet,tor} in docs; with experimental notice --- clanServices/internet/README.md | 10 +++++++++- clanServices/internet/default.nix | 1 - clanServices/tor/README.md | 10 +++++++++- docs/mkdocs.yml | 2 ++ pkgs/docs-from-code/generate/__init__.py | 4 ---- 5 files changed, 20 insertions(+), 7 deletions(-) diff --git a/clanServices/internet/README.md b/clanServices/internet/README.md index 83a980b54..d712fadd7 100644 --- a/clanServices/internet/README.md +++ b/clanServices/internet/README.md @@ -1,3 +1,11 @@ +🚧🚧🚧 Experimental 🚧🚧🚧 + +Use at your own risk. + +We are still refining its interfaces, instability and breakages are expected. + +--- + This module is part of Clan's [networking interface](https://docs.clan.lol/guides/networking/networking/). Clan's networking module automatically manages connections across available network transports and falls back intelligently. When you run `clan ssh` or `clan machines update`, Clan attempts each configured network in priority order until a connection succeeds. @@ -16,4 +24,4 @@ The example below shows how to configure a domain so server1 is reachable over t }; }; }; -``` \ No newline at end of file +``` diff --git a/clanServices/internet/default.nix b/clanServices/internet/default.nix index ebc4f9ec4..20b5e9d57 100644 --- a/clanServices/internet/default.nix +++ b/clanServices/internet/default.nix @@ -8,7 +8,6 @@ "Network" ]; manifest.readme = builtins.readFile ./README.md; - roles.default = { description = "Placeholder role to apply the internet service"; interface = diff --git a/clanServices/tor/README.md b/clanServices/tor/README.md index ff31b1acd..693dddf38 100644 --- a/clanServices/tor/README.md +++ b/clanServices/tor/README.md @@ -1,3 +1,11 @@ +🚧🚧🚧 Experimental 🚧🚧🚧 + +Use at your own risk. + +We are still refining its interfaces, instability and breakages are expected. + +--- + This module is part of Clan's [networking interface](https://docs.clan.lol/guides/networking/networking/). Clan's networking module automatically manages connections across available network transports and falls back intelligently. When you run `clan ssh` or `clan machines update`, Clan attempts each configured network in priority order until a connection succeeds. @@ -11,4 +19,4 @@ The example below configures all your nixos machines to be reachable over the To roles.server.tags.nixos = { }; }; }; -``` \ No newline at end of file +``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 380a5d63d..9743be9e0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -164,6 +164,7 @@ nav: - services/official/emergency-access.md - services/official/garage.md - services/official/hello-world.md + - services/official/internet.md - services/official/importer.md - services/official/kde.md - services/official/localbackup.md @@ -174,6 +175,7 @@ nav: - services/official/sshd.md - services/official/syncthing.md - services/official/trusted-nix-caches.md + - services/official/tor.md - services/official/users.md - services/official/wifi.md - services/official/wireguard.md diff --git a/pkgs/docs-from-code/generate/__init__.py b/pkgs/docs-from-code/generate/__init__.py index 71f910ab6..628d2d3a9 100644 --- a/pkgs/docs-from-code/generate/__init__.py +++ b/pkgs/docs-from-code/generate/__init__.py @@ -313,10 +313,6 @@ def produce_clan_service_docs() -> None: service_links: dict[str, dict[str, dict[str, Any]]] = json.load(f3) for module_name, module_info in service_links.items(): - # Skip specific modules that are not ready for documentation - if module_name in ["internet", "tor"]: - continue - output = f"# {module_name}\n\n" # output += f"`clan.modules.{module_name}`\n" output += f"*{module_info['manifest']['description']}*\n"