Add packaged user manual and configuration guides to web console

This commit is contained in:
Nico committed 2026-10-23 15:18:02 +02:00
1 parent b42bafb711
commit 085a5c4026
17 files changed
+586 -7

No files matched your search

+42
View File
@@ -0,0 +1,42 @@
# Benutzeranleitung in der Weboberfläche – 2026-10-23
Ergebnis: eigener Reiter mit neun Dokumenten, Inhaltsverzeichnis, sicheren
Markdown-Darstellungen und Markdown-Download. Neue allgemeine Bedienungs- und
Funktionsbeschreibung sowie Projekt-/Source-/DB-/Modellkonfigurationsanleitung.
Vorhandene Einrichtungsanleitungen werden eingebunden, nicht als Serverpfade
verlinkt. Die Übergabe-API-Dokumentation wurde an den vorhandenen Webbetrieb
und die Web-Schlüsselverwaltung angepasst.
Quellen: `docs/` und `deploy/capture-worker/README.md`, feste Auswahlliste in
`scripts/build_user_manual.py`. Die generierte Webressource wird mit dem Paket
ausgeliefert. Ein Drift-Test verhindert unbemerkte Abweichungen von den Quellen.
Keine tatsächlichen Konfigurationen oder Zugangsdaten im Bundle.
Validierung:
```text
python -m pytest tests/test_user_manual.py tests/test_dashboard.py tests/test_web_auth.py tests/test_human_web.py -q
28 passed, 1 dependency deprecation warning
node tests/dashboard-smoke.mjs
PASS, console_errors: [], overflow: false
python scripts/build_user_manual.py --check
PASS
node --check src/viano_bug_analysis/web/user-manual.js
PASS
pip wheel --no-deps --no-index --no-build-isolation .
PASS, manual JSON and renderer included in wheel
```
Nach Ergänzung des Pflegehinweises die manuelspezifischen Tests erneut bestanden.
Browser prüft Login, Dokumentauswahl, Inhaltsverzeichnis, Linux-Befehle,
Konfigurationstabellen, HTML-/URL-Abwehr im Renderer und Logout. Desktop- und
Mobilansicht visuell kontrolliert. Quellen bleiben als Markdown separat pflegbar.
Die Darstellung unterstützt die im Korpus verwendeten Überschriften, Listen,
Tabellen, Codeblöcke, Inline-Code, Hervorhebungen und bekannte Dokumentverweise;
beliebiges HTML wird als Text angezeigt.
Vor lokalen Tests Trials 16.939.129.428 Bytes und Fehlerkorpus 2.471.041 Bytes;
kleine temporäre synthetische Testdaten und Paket-Builds halten das Gesamtbudget
weiter unter 20 GB. Temporäres Wheel nach Prüfung entfernt. Keine realen
Fallkopien, Modellanfragen, Cloudkosten, Dienststarts oder Serveränderungen.
`docs/architecture.md` unverändert. Kein Push.