From 0dc08b003da8337ef88f5735a3567cfbfac5a43b Mon Sep 17 00:00:00 2001
From: dschlueter <dschlueter@kitux.de>
Date: Tue, 7 Jul 2026 11:08:33 +0200
Subject: [PATCH] docs: add a documentation index and repo inventory
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Improve orientation across the doc set without duplicating content:

- README: add a "Dokumentation" table mapping each doc (README,
  BEDIENUNGSANLEITUNG, INSTALL_FROM_ARCHIVE, SECURITY_AND_OPERATIONS, man
  page, CHANGELOG) to who it is for and what it covers.
- SECURITY_AND_OPERATIONS §1: extend the module map with a repo-level
  inventory (tests, config template, packaging, build/CI/hook scripts,
  docs) so "which file does what" is answered beyond the src/ modules.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
---
 README.md                       | 11 +++++++++++
 docs/SECURITY_AND_OPERATIONS.md | 21 +++++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 6f27152..4f8a13c 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,17 @@ Text, Datei oder Remote-URL.
 einziges Python-Paket mit konsistenter Konfiguration, Locking und
 Fehlerbehandlung.
 
+## Dokumentation
+
+| Dokument | Für wen / wofür |
+|---|---|
+| README (diese Datei) | Schnelleinstieg: Installation, Konfiguration, Verwendung |
+| [`BEDIENUNGSANLEITUNG.md`](BEDIENUNGSANLEITUNG.md) | Vollständiges Benutzerhandbuch (alle Aktionen, Optionen, Fehlersuche) |
+| [`INSTALL_FROM_ARCHIVE.md`](INSTALL_FROM_ARCHIVE.md) | Installation aus dem `.tar.gz`-Archiv + Archiv selbst bauen/verifizieren |
+| [`docs/SECURITY_AND_OPERATIONS.md`](docs/SECURITY_AND_OPERATIONS.md) | Architektur, Modul-/Repo-Übersicht, Sicherheits- & Betriebsmodell |
+| `man/llamacppctl.1` | Vollständige Optionsreferenz (`man llamacppctl` bzw. `man ./man/llamacppctl.1`) |
+| [`CHANGELOG.md`](CHANGELOG.md) | Versionshistorie |
+
 ## Installation
 
 ```bash
diff --git a/docs/SECURITY_AND_OPERATIONS.md b/docs/SECURITY_AND_OPERATIONS.md
index 62b1230..b25dc2f 100644
--- a/docs/SECURITY_AND_OPERATIONS.md
+++ b/docs/SECURITY_AND_OPERATIONS.md
@@ -27,6 +27,27 @@ HTTP-Details. `docker_ops.py`/`http_ops.py` kennen keine CLI-Semantik. Diese
 Trennung hält die sicherheitsrelevante Logik (Eingabevalidierung) unabhängig
 testbar von der Orchestrierung.
 
+### Repo-Inventur (über den Code hinaus)
+
+```
+tests/                    Test-Suite (pytest; gemocktes subprocess/requests, DNS-Pinning)
+man/llamacppctl.1         Unix-Manpage: vollständige Optionsreferenz
+llama.cpp.config.example  Konfigurationsvorlage -> nach llama.cpp.config kopieren
+pyproject.toml            Paket-/Build-Metadaten, dev-Extras, ruff-/mypy-Config
+requirements.txt          Laufzeit-Install (Zeiger auf das Paket; pyproject ist Quelle)
+requirements-dev.txt      Entwickler-Install (`-e .[dev]`)
+build_archive.py          Reproduzierbarer .tar.gz-Builder mit Selbstverifikation
+scripts/check.sh          Lokales CI-Gate: ruff + mypy + pytest
+scripts/smoke.sh          Opt-in End-to-End-Rauchtest gegen echten Docker + GPU
+.githooks/pre-push        Pre-Push-Hook (ruft scripts/check.sh) — aktivieren via
+                          `git config core.hooksPath .githooks`
+.forgejo/workflows/ci.yml Forgejo-Actions-CI (läuft, sobald ein Runner registriert ist)
+README.md                 Schnelleinstieg + Doku-Index
+BEDIENUNGSANLEITUNG.md    Vollständiges Benutzerhandbuch
+INSTALL_FROM_ARCHIVE.md   Installation aus dem Archiv + Archiv bauen/verifizieren
+CHANGELOG.md / LICENSE    Versionshistorie / MIT-Lizenz
+```
+
 ## 2. Konfigurationsmodell
 
 `llama.cpp.config` ist eine Standard-INI-Datei (`configparser`). Auflösung