Beschreibe den Doku-Leseweg über die gebaute MkDocs-Seite

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
2026-09-04 20:03:07 +02:00
co-authored by Claude Fable 5.1
parent 125a8b9c0f
commit a8704fcddd
2 changed files with 19 additions and 0 deletions
+11
View File
@@ -17,6 +17,7 @@ Chart selbst gehört zu hive (Schnitt im Haupt-README).
| Quelle | `git.home`, Organisation `ahmann`, Namespace `familie`, Klassifikation `home` |
| Oberfläche | `https://hive.home/km/` (SilverBullet, Login aus OpenBao `elton/km-home`) |
| API | `https://hive.home/km/api/v1/…`, `https://hive.home/km/health` |
| Doku | `https://hive.home/doku/info/` — statische MkDocs-Seite aus dem info-Checkout, von km nach jedem Pull mit Änderung gebaut (`/srv/km/data/site/info`, Caddy `file_server`) |
| Takt | alle 5 Minuten: ziehen, Gitea einlesen, indexieren, Geändertes committen und pushen |
| Vektoren | **aus** (`KM_EMBED=0`) — erst, wenn es einen Abnehmer gibt; die Ollama-Instanz auf s18 ist vom LXC aus ohne VLAN5-Route nicht erreichbar |
| 42i-hc | `/srv/km/health` prüft die API und den letzten Lauf |
@@ -59,6 +60,16 @@ Firmen-Token gehört nicht auf den Familien-LXC), wird es **im LXC gebaut**:
initialisiert die Ablage deshalb **in place** und holt den Remote-Stand
dazu; `.silverbullet*` und `*/doku/` stehen in der `.gitignore` der Ablage.
## Doku lesen: MkDocs statt SilverBullet
Andreas, 04.09.: SilverBullet ist für die Doku nicht das Richtige — sie soll
aussehen wie sie soll, lesen statt editieren, ohne Auto-Commit-Problem. km
baut deshalb jede Quelle mit `mkdocs.yml` nach jedem Pull mit Änderung als
statische Seite (`mkdocs-material` im Image, ~60 s auf dem LXC) nach
`/srv/km/data/site/<name>`; Caddy mountet das Verzeichnis read-only und
liefert es unter `/doku/<name>/` aus. Ein Baufehler lässt die alte Seite
stehen und erscheint im Lauf-Ergebnis (`site_<name>: FEHLER …`).
## Oberfläche: Seitenleiste
SilverBullet hat keine Ordnernavigation. Die liefert das **TreeView-Plug**
+8
View File
@@ -32,6 +32,14 @@ KM_SOURCES=info=https://git.home/ahmann/info.git@master
`name=url[@branch]`, mehrere durch Komma. Zugang: dieselben `KM_GIT_USER`/
`KM_GIT_PASSWORD` wie für die Ablage; die `.netrc` bekommt jeden Remote-Host.
## Lesen: statische Seite
Hat die Quelle ein `mkdocs.yml`, baut km sie nach jedem Pull mit Änderung
mit `python -m mkdocs build` nach `<data>/site/<name>` — die gewohnte
MkDocs-Darstellung, read-only, ohne laufenden Dienst. Caddy liefert sie unter
`/doku/<name>/` aus (deploy/README.md). SilverBullet bleibt für die Ablage
selbst; für die Doku ist die gebaute Seite der Leseweg.
## Was Andreas wissen sollte
- **Alles ist drin**, auch `corp`- und `lan`-Seiten — bis die Quellen