- Added the `Interview_Config_Guide.md` for comprehensive instructions on creating interview profiles and utilizing various note types. - Updated `00_Dokumentations_Index.md` to include links to the new guide and improved navigation for WP-26 related resources. - Enhanced `06_Konfigurationsdateien_Referenz.md` with references to the new guide and clarified YAML structure for interview configurations. - Introduced `audit_geburtsdatei.md` for detailed analysis of section connections and edge types, highlighting critical issues and recommendations for improvement. - Improved renderer tests to ensure proper handling of section types and edge generation, aligning with the new WP-26 features.
189 lines
9.8 KiB
Markdown
189 lines
9.8 KiB
Markdown
# Mindnet Causal Assistant - Dokumentations-Index
|
|
|
|
> **Version:** 1.0.0
|
|
> **Stand:** 2025-01-XX
|
|
> **Vollständige Übersicht:** Alle Dokumentations-Dateien und deren Inhalte
|
|
|
|
---
|
|
|
|
## Dokumentations-Struktur
|
|
|
|
### Hauptdokumentation (nach Zielgruppe)
|
|
|
|
1. **[01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md)** - Endnutzer
|
|
2. **[02_Administratorhandbuch.md](./02_Administratorhandbuch.md)** - Administratoren
|
|
3. **[03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md)** - Entwickler
|
|
4. **[04_Architektur.md](./04_Architektur.md)** - Architekten
|
|
5. **[05_Installation_Deployment.md](./05_Installation_Deployment.md)** - Installation
|
|
|
|
### Spezialisierte Referenzen
|
|
|
|
6. **[06_Konfigurationsdateien_Referenz.md](./06_Konfigurationsdateien_Referenz.md)** - Config-Dateien Format & Aufbau
|
|
7. **[Interview_Config_Guide.md](./Interview_Config_Guide.md)** - Vollständige Anleitung für `interview_config.yaml` (inkl. WP-26 Features, GenAI-freundlich)
|
|
8. **[07_Event_Handler_Commands.md](./07_Event_Handler_Commands.md)** - Event Handler & Commands
|
|
|
|
### WP-26 Integration (Section Types & Intra-Note-Edges)
|
|
|
|
9. **[06_LH_WP26_Plugin_Integration.md](./06_LH_WP26_Plugin_Integration.md)** - Lastenheft für WP-26 Plugin-Integration (vollständige Anforderungen)
|
|
10. **[WP26_Plugin_Interface_Specification.md](./WP26_Plugin_Interface_Specification.md)** - Vollständige Schnittstellenspezifikation für Plugin-Entwicklung
|
|
11. **[WP26_Implementation_Checklist.md](./WP26_Implementation_Checklist.md)** - Implementierungs-Checkliste mit Tasks und Phasen
|
|
|
|
### Chain Inspector Reports
|
|
|
|
- [CHAIN_INSPECTOR_V0_REPORT.md](./CHAIN_INSPECTOR_V0_REPORT.md) - v0.0 Implementierung
|
|
- [CHAIN_INSPECTOR_V02_REPORT.md](./CHAIN_INSPECTOR_V02_REPORT.md) - v0.2 Features
|
|
- [CHAIN_INSPECTOR_V03_REPORT.md](./CHAIN_INSPECTOR_V03_REPORT.md) - v0.3 Features
|
|
- [CHAIN_INSPECTOR_V04_REPORT.md](./CHAIN_INSPECTOR_V04_REPORT.md) - v0.4 Template Matching
|
|
- [CHAIN_INSPECTOR_V042_REPORT.md](./CHAIN_INSPECTOR_V042_REPORT.md) - v0.4.2 Updates
|
|
|
|
### Konzepte & Details
|
|
|
|
- [02_causal_chain_retrieving.md](./02_causal_chain_retrieving.md) - Kausale Ketten-Retrieval
|
|
- [DANGLING_TARGET_CASES.md](./DANGLING_TARGET_CASES.md) - Dangling Target Findings
|
|
|
|
### Legacy-Dokumentation
|
|
|
|
- [readme.md](./readme.md) - MVP 1.0 Quickstart
|
|
- [Handbuch.md](./Handbuch.md) - MVP 1.0 Handbuch
|
|
- [TESTING_WITH_REAL_VAULT.md](./TESTING_WITH_REAL_VAULT.md) - Testing mit echtem Vault
|
|
|
|
---
|
|
|
|
## Vollständigkeits-Checkliste
|
|
|
|
### ✅ Module & Komponenten
|
|
|
|
- [x] **Analysis** (`src/analysis/`) - Chain Inspector, Template Matching, Graph Index, Section Context, Severity Policy
|
|
- [x] **Commands** (`src/commands/`) - Inspect Chains, Fix Findings
|
|
- [x] **Dictionary** (`src/dictionary/`) - Chain Roles Loader, Chain Templates Loader, Config Path Manager, Dictionary Loader, Parsers, Types
|
|
- [x] **Entity Picker** (`src/entityPicker/`) - Note Index, Folder Tree, Filters, Wikilink
|
|
- [x] **Export** (`src/export/`) - Graph Export
|
|
- [x] **Graph** (`src/graph/`) - Graph Builder, Graph Index, Render Chain Report, Resolve Target, Traverse
|
|
- [x] **Interview** (`src/interview/`) - Config Loader, Parser, Wizard State, Loop State, Renderer, Write Frontmatter, Section Key Resolver, Extract Target, Slugify
|
|
- [x] **Lint** (`src/lint/`) - Lint Engine, Rules (Hub Has Causality, Missing Target, Unknown Edge)
|
|
- [x] **Mapping** (`src/mapping/`) - Semantic Mapping Builder, Mapping Extractor, Mapping Builder, Edge Type Selector, Update Mapping Blocks, Section Parser, Worklist Builder, Graph Schema, Schema Helper, Folder Helpers
|
|
- [x] **Parser** (`src/parser/`) - Parse Edges From Callouts, Parse Frontmatter, Parse Rel Links
|
|
- [x] **Schema** (`src/schema/`) - Graph Schema Loader
|
|
- [x] **UI** (`src/ui/`) - Alle Modals (Interview Wizard, Profile Selection, Edge Type Chooser, Entity Picker, Adopt Note, Folder Tree, Link Prompt, Inline Edge Type, Confirm Overwrite), Settings Tab, Markdown Toolbar, Mindnet View
|
|
- [x] **Unresolved Link** (`src/unresolvedLink/`) - Handler, Link Helpers, Adopt Helpers
|
|
- [x] **Vocabulary** (`src/vocab/`) - Vocabulary, Vocabulary Loader, Parse Edge Vocabulary
|
|
|
|
### ✅ Funktionen & Features
|
|
|
|
- [x] **Note-Erstellung** - Mit Profilen, Frontmatter-Generierung
|
|
- [x] **Interview-Wizard** - Steps, Loops, Nested Loops, Section-basierte Ausgabe
|
|
- [x] **Semantic Mapping** - Builder, Extractor, Edge Type Assignment
|
|
- [x] **Chain Inspector** - Template Matching, Findings Generation
|
|
- [x] **Fix Findings** - Automatische Behebung von Findings
|
|
- [x] **Unresolved Link Handling** - Reading View, Editor, Note Adoption
|
|
- [x] **Edge-Type-Änderung** - Kontext-Erkennung, Edge Type Selector
|
|
- [x] **Graph Export** - JSON-Export
|
|
- [x] **Linting** - Lint Engine mit Regeln
|
|
- [x] **Live-Reload** - Automatisches Neuladen von Config-Dateien
|
|
|
|
### ✅ Commands
|
|
|
|
- [x] `mindnet-reload-edge-vocabulary` - Edge Vocabulary neu laden
|
|
- [x] `mindnet-validate-current-note` - Note validieren (Lint)
|
|
- [x] `mindnet-export-graph` - Graph exportieren
|
|
- [x] `mindnet-show-chains-from-current-note` - Ketten von aktueller Note zeigen
|
|
- [x] `mindnet-create-note-from-profile` - Note mit Profil erstellen
|
|
- [x] `mindnet-change-edge-type` - Edge-Type ändern
|
|
- [x] `mindnet-debug-chain-roles` - Chain Roles Debug-Info
|
|
- [x] `mindnet-debug-chain-templates` - Chain Templates Debug-Info
|
|
- [x] `mindnet-fix-findings` - Findings beheben
|
|
- [x] `mindnet-inspect-chains` - Chains analysieren
|
|
- [x] `mindnet-build-semantic-mappings` - Semantic Mapping Blöcke bauen
|
|
|
|
### ✅ Event Handler
|
|
|
|
- [x] **Vault Modify Event** - Live-Reload von Config-Dateien
|
|
- [x] **Vault Create Event** - Note Adoption
|
|
- [x] **Markdown Post Processor** - Unresolved Link Handling (Reading View)
|
|
- [x] **DOM Click Event** - Unresolved Link Handling (Editor)
|
|
|
|
### ✅ Settings
|
|
|
|
- [x] **Pfad-Settings** (6) - Alle Config-Datei-Pfade
|
|
- [x] **Graph & Chain Settings** (4) - maxHops, strictMode, showCanonicalHints, chainDirection
|
|
- [x] **Interview Settings** (1) - autoStartInterviewOnCreate
|
|
- [x] **Unresolved Link Settings** (6) - interceptUnresolvedLinkClicks, autoStartOnUnresolvedClick, bypassModifier, editorFollowModifier, waitForFirstModifyAfterCreate, waitForModifyTimeoutMs, debugLogging
|
|
- [x] **Note Adoption Settings** (4) - adoptNewNotesInEditor, adoptMaxChars, adoptConfirmMode, highConfidenceWindowMs
|
|
- [x] **Semantic Mapping Settings** (6) - mappingWrapperCalloutType, mappingWrapperTitle, mappingWrapperFolded, defaultEdgeType, unassignedHandling, allowOverwriteExistingMappings, defaultNotesFolder
|
|
- [x] **Inline Micro Edge Suggester Settings** (3) - inlineMicroEnabled, inlineMaxAlternatives, inlineCancelBehavior
|
|
- [x] **Export Settings** (1) - exportPath
|
|
- [x] **Chain Inspector Settings** (3) - chainInspectorIncludeCandidates, chainInspectorMaxTemplateMatches, templateMatchingProfile
|
|
- [x] **Fix Actions Settings** (5) - createMissingNote (mode, defaultTypeStrategy, includeZones), createMissingHeading (level), promoteCandidate (keepOriginal)
|
|
|
|
### ✅ Konfigurationsdateien
|
|
|
|
- [x] **edge_vocabulary.md** - Format, Parsing-Regeln, Beispiel
|
|
- [x] **graph_schema.md** - Format, Parsing-Regeln, Beispiel
|
|
- [x] **interview_config.yaml** - Format, Felder, Beispiel (Profile, Steps, Loops) - **Siehe auch:** [Interview_Config_Guide.md](./Interview_Config_Guide.md) für vollständige Anleitung
|
|
- [x] **chain_roles.yaml** - Format, Felder, Beispiel (Roles, Edge Types)
|
|
- [x] **chain_templates.yaml** - Format, Felder, Beispiel (Templates, Slots, Links, Defaults, Profiles)
|
|
- [x] **analysis_policies.yaml** - Geplante Struktur (noch nicht vollständig implementiert)
|
|
|
|
### ✅ Wirkungsweise
|
|
|
|
- [x] **Live-Reload** - Debounced (200ms), Last-Known-Good Fallback
|
|
- [x] **Config-Loading** - YAML/Markdown Parsing, Error Handling
|
|
- [x] **Template Matching** - Slot-basiertes Matching, Link Constraints
|
|
- [x] **Findings Generation** - Gap-Heuristiken, Severity-Policy
|
|
- [x] **Note Adoption** - Confidence-Evaluation, Adoption-Flow
|
|
- [x] **Unresolved Link Handling** - Reading View vs Editor, Modifier-Keys
|
|
- [x] **Semantic Mapping** - Section-Parsing, Link-Extraktion, Edge-Type-Assignment
|
|
|
|
---
|
|
|
|
## Dokumentations-Abdeckung
|
|
|
|
### Vollständig dokumentiert
|
|
|
|
✅ **Alle Module** - Alle 14 Hauptmodule sind dokumentiert
|
|
✅ **Alle Commands** - Alle 11 Commands sind dokumentiert
|
|
✅ **Alle Event Handler** - Alle 4 Event Handler sind dokumentiert
|
|
✅ **Alle Settings** - Alle 40+ Settings sind dokumentiert
|
|
✅ **Alle Config-Dateien** - Alle 6 Config-Dateien sind dokumentiert
|
|
✅ **Wirkungsweise** - Alle Hauptfunktionen sind beschrieben
|
|
✅ **Konfiguration** - Format und Aufbau aller Config-Dateien sind dokumentiert
|
|
|
|
### Teilweise dokumentiert
|
|
|
|
⚠️ **Analysis Policies** - Erwähnt, aber noch nicht vollständig implementiert
|
|
⚠️ **Einige UI-Komponenten** - Basis-Funktionalität dokumentiert, Details könnten erweitert werden
|
|
|
|
### Nicht dokumentiert (nicht vorhanden oder nicht relevant)
|
|
|
|
- **Tests** - Test-Dateien sind nicht Teil der Benutzer-Dokumentation
|
|
- **Mocks** - Mock-Dateien sind nicht Teil der Benutzer-Dokumentation
|
|
- **Build-Scripts** - Build-Scripts sind in Entwicklerhandbuch dokumentiert
|
|
|
|
---
|
|
|
|
## Schnellzugriff nach Thema
|
|
|
|
### Installation & Setup
|
|
→ [05_Installation_Deployment.md](./05_Installation_Deployment.md)
|
|
|
|
### Konfiguration
|
|
→ [02_Administratorhandbuch.md](./02_Administratorhandbuch.md)
|
|
→ [06_Konfigurationsdateien_Referenz.md](./06_Konfigurationsdateien_Referenz.md)
|
|
→ [Interview_Config_Guide.md](./Interview_Config_Guide.md) - Interview-Profile erstellen (GenAI-freundlich)
|
|
|
|
### Nutzung
|
|
→ [01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md)
|
|
→ [07_Event_Handler_Commands.md](./07_Event_Handler_Commands.md)
|
|
|
|
### Entwicklung
|
|
→ [03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md)
|
|
→ [04_Architektur.md](./04_Architektur.md)
|
|
|
|
### WP-26 Integration
|
|
→ [WP26_Plugin_Interface_Specification.md](./WP26_Plugin_Interface_Specification.md)
|
|
→ [WP26_Implementation_Checklist.md](./WP26_Implementation_Checklist.md)
|
|
|
|
---
|
|
|
|
**Ende des Dokumentations-Index**
|