diff --git a/docs/admin_guide.md b/docs/admin_guide.md index 7d67da6..2c3e60a 100644 --- a/docs/admin_guide.md +++ b/docs/admin_guide.md @@ -6,6 +6,34 @@ > Dieses Handbuch richtet sich an **Administratoren**. Es beschreibt Installation, Konfiguration, Backup-Strategien, Monitoring und den sicheren Betrieb der Mindnet-Instanz (API + DB + LLM). +--- +
+📖 Inhaltsverzeichnis (Klicken zum Öffnen) + +- [Mindnet v2.2 – Admin Guide](#mindnet-v22--admin-guide) + - [1. Zielgruppe \& Scope](#1-zielgruppe--scope) + - [2. Initial Setup \& Installation](#2-initial-setup--installation) + - [2.1 Systemvoraussetzungen](#21-systemvoraussetzungen) + - [2.2 Installation (Code)](#22-installation-code) + - [2.3 Qdrant Setup (Docker)](#23-qdrant-setup-docker) + - [2.4 Ollama Setup (LLM Service)](#24-ollama-setup-llm-service) + - [2.5 Konfiguration (ENV)](#25-konfiguration-env) + - [2.6 Deployment via Systemd](#26-deployment-via-systemd) + - [3. Betrieb im Alltag](#3-betrieb-im-alltag) + - [3.1 Regelmäßige Importe](#31-regelmäßige-importe) + - [3.2 Health-Checks](#32-health-checks) + - [3.3 Logs \& Monitoring](#33-logs--monitoring) + - [4. Update-Prozess](#4-update-prozess) + - [5. Backup \& Restore](#5-backup--restore) + - [5.1 Vault-Backup (Priorität 1)](#51-vault-backup-priorität-1) + - [5.2 Qdrant-Snapshots (Priorität 2)](#52-qdrant-snapshots-priorität-2) + - [5.3 Log-Daten (Priorität 3)](#53-log-daten-priorität-3) + - [5.4 Notfall-Wiederherstellung (Rebuild)](#54-notfall-wiederherstellung-rebuild) + - [6. Governance \& Sicherheit](#6-governance--sicherheit) + - [6.1 Zugriffsschutz](#61-zugriffsschutz) + - [6.2 Typen-Governance](#62-typen-governance) + + --- ## 1. Zielgruppe & Scope diff --git a/docs/mindnet_technical_architecture.md b/docs/mindnet_technical_architecture.md index 1627bc9..dcf6d70 100644 --- a/docs/mindnet_technical_architecture.md +++ b/docs/mindnet_technical_architecture.md @@ -7,6 +7,45 @@ > **Ziel dieses Dokuments:** > Vollständige Beschreibung der technischen Architektur inkl. Graph-Datenbank, Retrieval-Logik und der **neuen RAG-Komponenten (LLM/Chat)**. +--- +
+📖 Inhaltsverzeichnis (Klicken zum Öffnen) + +- [Mindnet v2.2 – Technische Architektur](#mindnet-v22--technische-architektur) + - [](#) + - [1. Systemüberblick](#1-systemüberblick) + - [1.1 Architektur-Zielbild](#11-architektur-zielbild) + - [1.2 Verzeichnisstruktur \& Komponenten (Post-WP05)](#12-verzeichnisstruktur--komponenten-post-wp05) + - [2. Datenmodell \& Collections (Qdrant)](#2-datenmodell--collections-qdrant) + - [2.1 Notes Collection (`_notes`)](#21-notes-collection-prefix_notes) + - [2.2 Chunks Collection (`_chunks`)](#22-chunks-collection-prefix_chunks) + - [2.3 Edges Collection (`_edges`)](#23-edges-collection-prefix_edges) + - [3. Konfiguration](#3-konfiguration) + - [3.1 Typ-Registry (`config/types.yaml`)](#31-typ-registry-configtypesyaml) + - [3.2 Retriever-Config (`config/retriever.yaml`)](#32-retriever-config-configretrieveryaml) + - [3.3 Prompts (`config/prompts.yaml`)](#33-prompts-configpromptsyaml) + - [3.4 Environment (`.env`)](#34-environment-env) + - [4. Import-Pipeline (Markdown → Qdrant)](#4-import-pipeline-markdown--qdrant) + - [4.1 Verarbeitungsschritte](#41-verarbeitungsschritte) + - [5. Retriever-Architektur \& Scoring](#5-retriever-architektur--scoring) + - [5.1 Betriebsmodi](#51-betriebsmodi) + - [5.2 Scoring-Formel (WP04a)](#52-scoring-formel-wp04a) + - [5.3 Explanation Layer (WP04b)](#53-explanation-layer-wp04b) + - [5.4 Graph-Expansion](#54-graph-expansion) + - [6. RAG \& Chat Architektur (WP05)](#6-rag--chat-architektur-wp05) + - [6.1 Schritt 1: Intent \& Retrieval](#61-schritt-1-intent--retrieval) + - [6.2 Schritt 2: Context Enrichment (Das "Context Intelligence" Pattern)](#62-schritt-2-context-enrichment-das-context-intelligence-pattern) + - [6.3 Schritt 3: Generation (LLM Service)](#63-schritt-3-generation-llm-service) + - [6.4 Schritt 4: Response \& Traceability](#64-schritt-4-response--traceability) + - [7. Feedback \& Logging Architektur (WP04c)](#7-feedback--logging-architektur-wp04c) + - [7.1 Komponenten](#71-komponenten) + - [7.2 Log-Dateien](#72-log-dateien) + - [7.3 Traceability](#73-traceability) + - [8. Indizes \& Performance](#8-indizes--performance) + - [9. Offene Punkte / Known Limitations](#9-offene-punkte--known-limitations) + + +
--- ## 1. Systemüberblick diff --git a/docs/pipeline_playbook.md b/docs/pipeline_playbook.md index a3fd711..78de362 100644 --- a/docs/pipeline_playbook.md +++ b/docs/pipeline_playbook.md @@ -4,6 +4,37 @@ **Status:** **FINAL** (Inkl. WP05 RAG Pipeline) **Quellen:** `mindnet_v2_implementation_playbook.md`, `Handbuch.md`, `chunking_strategy.md`, `docs_mindnet_retriever.md`, `mindnet_admin_guide_v2.2.md`. +--- +
+📖 Inhaltsverzeichnis (Klicken zum Öffnen) + +- [mindnet v2.2 – Pipeline Playbook](#mindnet-v22--pipeline-playbook) + - [1. Zweck \& Einordnung](#1-zweck--einordnung) + - [2. Die Import-Pipeline (Runbook)](#2-die-import-pipeline-runbook) + - [2.1 Der 12-Schritte-Prozess](#21-der-12-schritte-prozess) + - [2.2 Standard-Betrieb (Inkrementell)](#22-standard-betrieb-inkrementell) + - [2.3 Deployment \& Restart (Systemd)](#23-deployment--restart-systemd) + - [2.4 Full Rebuild (Clean Slate)](#24-full-rebuild-clean-slate) + - [3. Chunking \& Payload-Aufbau](#3-chunking--payload-aufbau) + - [3.1 Chunk-Profile](#31-chunk-profile) + - [3.2 Payload-Felder](#32-payload-felder) + - [4. Edge-Erzeugung (Die V2-Logik)](#4-edge-erzeugung-die-v2-logik) + - [4.1 Prioritäten \& Provenance](#41-prioritäten--provenance) + - [4.2 Typ-Defaults](#42-typ-defaults) + - [5. Retriever, Chat \& Generation (RAG Pipeline)](#5-retriever-chat--generation-rag-pipeline) + - [5.1 Retrieval (Hybrid)](#51-retrieval-hybrid) + - [5.2 Context Enrichment (Das "Context Intelligence" Pattern)](#52-context-enrichment-das-context-intelligence-pattern) + - [5.3 Generation (LLM)](#53-generation-llm) + - [5.4 Explanation Mode (WP04b)](#54-explanation-mode-wp04b) + - [6. Feedback \& Lernen (WP04c)](#6-feedback--lernen-wp04c) + - [7. Quality Gates \& Tests](#7-quality-gates--tests) + - [7.1 Pflicht-Tests vor Commit](#71-pflicht-tests-vor-commit) + - [7.2 Smoke-Test (E2E)](#72-smoke-test-e2e) + - [8. Ausblick \& Roadmap (Technische Skizzen)](#8-ausblick--roadmap-technische-skizzen) + - [8.1 WP-06: Decision Engine (Skizze)](#81-wp-06-decision-engine-skizze) + - [8.2 WP-08: Self-Tuning (Skizze)](#82-wp-08-self-tuning-skizze) + + --- ## 1. Zweck & Einordnung