docs: add a documentation index and repo inventory

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>
This commit is contained in:
Dieter Schlüter 2026-07-07 11:08:33 +02:00
commit 0dc08b003d
2 changed files with 32 additions and 0 deletions

View file

@ -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