Lars
74cacdd41d
- Revamped the README to provide comprehensive documentation for the Mindnet Causal Assistant plugin, including user, administrator, developer, and architect guides. - Added specialized documentation sections for installation, deployment, and troubleshooting. - Enhanced the chain inspection logic to determine effective required links based on template definitions, profiles, and defaults, improving the accuracy of findings related to link completeness.
233 lines
6.3 KiB
Markdown
233 lines
6.3 KiB
Markdown
# Mindnet Causal Assistant - Dokumentation
|
|
|
|
> **Version:** 1.0.0
|
|
> **Stand:** 2025-01-XX
|
|
> **Übersicht:** Vollständige Dokumentation des Mindnet Causal Assistant Plugins
|
|
|
|
---
|
|
|
|
## Übersicht
|
|
|
|
Diese Dokumentation deckt alle Aspekte des **Mindnet Causal Assistant** Plugins ab - von der Installation über die Nutzung bis hin zur Entwicklung und Administration.
|
|
|
|
---
|
|
|
|
## Dokumente nach Zielgruppe
|
|
|
|
### 👤 Endnutzer
|
|
|
|
**Dokument:** [01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md)
|
|
|
|
**Inhalt:**
|
|
- Schnellstart
|
|
- Hauptfunktionen
|
|
- Workflows
|
|
- Commands im Detail
|
|
- Troubleshooting
|
|
|
|
**Für:** Nutzer, die das Plugin verwenden möchten
|
|
|
|
---
|
|
|
|
### ⚙️ Administratoren
|
|
|
|
**Dokument:** [02_Administratorhandbuch.md](./02_Administratorhandbuch.md)
|
|
|
|
**Inhalt:**
|
|
- Plugin-Konfiguration
|
|
- Konfigurationsdateien (YAML, Markdown)
|
|
- Pfad-Management
|
|
- Live-Reload
|
|
- Wartung & Troubleshooting
|
|
|
|
**Für:** Administratoren, Config-Manager, Vault-Verwalter
|
|
|
|
---
|
|
|
|
### 👨💻 Entwickler
|
|
|
|
**Dokument:** [03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md)
|
|
|
|
**Inhalt:**
|
|
- Projekt-Struktur
|
|
- Entwicklungsumgebung
|
|
- Code-Architektur
|
|
- Hauptmodule
|
|
- Erweiterungen entwickeln
|
|
- Testing
|
|
- Build & Deployment
|
|
|
|
**Für:** Entwickler, die am Plugin arbeiten oder es erweitern
|
|
|
|
---
|
|
|
|
### 🏗️ Architekten
|
|
|
|
**Dokument:** [04_Architektur.md](./04_Architektur.md)
|
|
|
|
**Inhalt:**
|
|
- System-Überblick
|
|
- Architektur-Prinzipien
|
|
- Komponenten-Architektur
|
|
- Datenfluss
|
|
- Konfigurations-Management
|
|
- Erweiterbarkeit
|
|
|
|
**Für:** Architekten, System-Designer, Entwickler
|
|
|
|
---
|
|
|
|
### 📦 Installation & Deployment
|
|
|
|
**Dokument:** [05_Installation_Deployment.md](./05_Installation_Deployment.md)
|
|
|
|
**Inhalt:**
|
|
- Voraussetzungen
|
|
- Installation (lokal, Community Plugin)
|
|
- Deployment (Development, Production)
|
|
- Konfiguration
|
|
- Upgrade
|
|
- Troubleshooting
|
|
|
|
**Für:** Administratoren, Entwickler, Erst-Installation
|
|
|
|
---
|
|
|
|
## Spezialisierte Dokumentation
|
|
|
|
### 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
|
|
- [06_Konfigurationsdateien_Referenz.md](./06_Konfigurationsdateien_Referenz.md) - Vollständige Referenz aller Config-Dateien
|
|
- [07_Event_Handler_Commands.md](./07_Event_Handler_Commands.md) - Event Handler & Commands Referenz
|
|
|
|
### Dokumentations-Index
|
|
|
|
- [00_Dokumentations_Index.md](./00_Dokumentations_Index.md) - Vollständige Übersicht aller Dokumentationen
|
|
|
|
### 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
|
|
|
|
---
|
|
|
|
## Schnellzugriff nach Thema
|
|
|
|
### Installation & Setup
|
|
|
|
1. **Erste Installation:** [05_Installation_Deployment.md](./05_Installation_Deployment.md) → Installation
|
|
2. **Konfiguration:** [02_Administratorhandbuch.md](./02_Administratorhandbuch.md) → Plugin-Konfiguration
|
|
3. **Schnellstart:** [01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md) → Schnellstart
|
|
|
|
### Nutzung
|
|
|
|
1. **Workflows:** [01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md) → Workflows
|
|
2. **Commands:** [01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md) → Commands im Detail
|
|
3. **Troubleshooting:** [01_Benutzerhandbuch.md](./01_Benutzerhandbuch.md) → Troubleshooting
|
|
|
|
### Konfiguration
|
|
|
|
1. **Config-Dateien:** [02_Administratorhandbuch.md](./02_Administratorhandbuch.md) → Konfigurationsdateien
|
|
2. **Pfad-Management:** [02_Administratorhandbuch.md](./02_Administratorhandbuch.md) → Pfad-Management
|
|
3. **Live-Reload:** [02_Administratorhandbuch.md](./02_Administratorhandbuch.md) → Live-Reload
|
|
|
|
### Entwicklung
|
|
|
|
1. **Setup:** [03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md) → Entwicklungsumgebung
|
|
2. **Code-Struktur:** [03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md) → Projekt-Struktur
|
|
3. **Erweiterungen:** [03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md) → Erweiterungen entwickeln
|
|
4. **Testing:** [03_Entwicklerhandbuch.md](./03_Entwicklerhandbuch.md) → Testing
|
|
|
|
### Architektur
|
|
|
|
1. **System-Überblick:** [04_Architektur.md](./04_Architektur.md) → System-Überblick
|
|
2. **Komponenten:** [04_Architektur.md](./04_Architektur.md) → Komponenten-Architektur
|
|
3. **Datenfluss:** [04_Architektur.md](./04_Architektur.md) → Datenfluss
|
|
|
|
---
|
|
|
|
## Dokumentations-Standards
|
|
|
|
### Format
|
|
|
|
- **Markdown:** Alle Dokumente in Markdown
|
|
- **Struktur:** Klare Hierarchie mit Inhaltsverzeichnis
|
|
- **Code-Beispiele:** Syntax-Highlighting
|
|
- **Tabellen:** Für strukturierte Informationen
|
|
|
|
### Versionierung
|
|
|
|
- **Version:** In jedem Dokument angegeben
|
|
- **Stand:** Datum der letzten Aktualisierung
|
|
- **Zielgruppe:** Klar definiert
|
|
|
|
### Aktualisierung
|
|
|
|
- **Bei Features:** Dokumentation aktualisieren
|
|
- **Bei Breaking Changes:** Changelog führen
|
|
- **Bei Bugfixes:** Troubleshooting aktualisieren
|
|
|
|
---
|
|
|
|
## Beitragen zur Dokumentation
|
|
|
|
### Verbesserungen
|
|
|
|
1. **Fehler melden:** Issues erstellen
|
|
2. **Verbesserungen vorschlagen:** Pull Requests
|
|
3. **Ergänzungen:** Neue Abschnitte hinzufügen
|
|
|
|
### Formatierung
|
|
|
|
- **Markdown:** Standard Markdown-Syntax
|
|
- **Code-Blöcke:** Mit Sprach-Angabe
|
|
- **Tabellen:** Für strukturierte Daten
|
|
- **Links:** Relative Links zu anderen Dokumenten
|
|
|
|
---
|
|
|
|
## Weitere Ressourcen
|
|
|
|
### Externe Links
|
|
|
|
- **Obsidian API:** https://docs.obsidian.md
|
|
- **Obsidian Plugin Guidelines:** https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines
|
|
- **TypeScript:** https://www.typescriptlang.org/
|
|
- **esbuild:** https://esbuild.github.io/
|
|
|
|
### Interne Ressourcen
|
|
|
|
- **Repository:** Siehe Haupt-README
|
|
- **Changelog:** Siehe Haupt-README
|
|
- **Issues:** GitHub Issues
|
|
|
|
---
|
|
|
|
## Kontakt & Support
|
|
|
|
### Fragen zur Dokumentation
|
|
|
|
- **Issues:** GitHub Issues erstellen
|
|
- **Pull Requests:** Verbesserungen einreichen
|
|
|
|
### Fragen zum Plugin
|
|
|
|
- **Issues:** GitHub Issues erstellen
|
|
- **Discussions:** GitHub Discussions (falls verfügbar)
|
|
|
|
---
|
|
|
|
**Letzte Aktualisierung:** 2025-01-XX
|
|
**Dokumentations-Version:** 1.0.0
|