docs: show {internet,tor} in docs; with experimental notice

This commit is contained in:
Johannes Kirschbauer
2025-10-17 09:27:17 +02:00
parent 8af166b899
commit f91aca959f
5 changed files with 20 additions and 7 deletions

View File

@@ -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/). 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. 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
}; };
}; };
}; };
``` ```

View File

@@ -8,7 +8,6 @@
"Network" "Network"
]; ];
manifest.readme = builtins.readFile ./README.md; manifest.readme = builtins.readFile ./README.md;
roles.default = { roles.default = {
description = "Placeholder role to apply the internet service"; description = "Placeholder role to apply the internet service";
interface = interface =

View File

@@ -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/). 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. 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 = { }; roles.server.tags.nixos = { };
}; };
}; };
``` ```

View File

@@ -164,6 +164,7 @@ nav:
- services/official/emergency-access.md - services/official/emergency-access.md
- services/official/garage.md - services/official/garage.md
- services/official/hello-world.md - services/official/hello-world.md
- services/official/internet.md
- services/official/importer.md - services/official/importer.md
- services/official/kde.md - services/official/kde.md
- services/official/localbackup.md - services/official/localbackup.md
@@ -174,6 +175,7 @@ nav:
- services/official/sshd.md - services/official/sshd.md
- services/official/syncthing.md - services/official/syncthing.md
- services/official/trusted-nix-caches.md - services/official/trusted-nix-caches.md
- services/official/tor.md
- services/official/users.md - services/official/users.md
- services/official/wifi.md - services/official/wifi.md
- services/official/wireguard.md - services/official/wireguard.md

View File

@@ -313,10 +313,6 @@ def produce_clan_service_docs() -> None:
service_links: dict[str, dict[str, dict[str, Any]]] = json.load(f3) service_links: dict[str, dict[str, dict[str, Any]]] = json.load(f3)
for module_name, module_info in service_links.items(): 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"# {module_name}\n\n"
# output += f"`clan.modules.{module_name}`\n" # output += f"`clan.modules.{module_name}`\n"
output += f"*{module_info['manifest']['description']}*\n" output += f"*{module_info['manifest']['description']}*\n"