Lars/mindnet_obsidian
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
74cacdd41d
mindnet_obsidian/docs/00_Dokumentations_Index.md
Lars 74cacdd41d
Some checks are pending
Node.js build / build (20.x) (push) Waiting to run
Details
Node.js build / build (22.x) (push) Waiting to run
Details
Update documentation and enhance chain inspection logic 
- 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.
2026-01-20 11:34:58 +01:00

8.8 KiB
Raw Blame History

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 - Endnutzer
  2. 02_Administratorhandbuch.md - Administratoren
  3. 03_Entwicklerhandbuch.md - Entwickler
  4. 04_Architektur.md - Architekten
  5. 05_Installation_Deployment.md - Installation

Spezialisierte Referenzen

  1. 06_Konfigurationsdateien_Referenz.md - Config-Dateien Format & Aufbau
  2. 07_Event_Handler_Commands.md - Event Handler & Commands

Chain Inspector Reports

Konzepte & Details

Legacy-Dokumentation

Vollständigkeits-Checkliste

✅ Module & Komponenten

  • Analysis (src/analysis/) - Chain Inspector, Template Matching, Graph Index, Section Context, Severity Policy
  • Commands (src/commands/) - Inspect Chains, Fix Findings
  • Dictionary (src/dictionary/) - Chain Roles Loader, Chain Templates Loader, Config Path Manager, Dictionary Loader, Parsers, Types
  • Entity Picker (src/entityPicker/) - Note Index, Folder Tree, Filters, Wikilink
  • Export (src/export/) - Graph Export
  • Graph (src/graph/) - Graph Builder, Graph Index, Render Chain Report, Resolve Target, Traverse
  • Interview (src/interview/) - Config Loader, Parser, Wizard State, Loop State, Renderer, Write Frontmatter, Section Key Resolver, Extract Target, Slugify
  • Lint (src/lint/) - Lint Engine, Rules (Hub Has Causality, Missing Target, Unknown Edge)
  • 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
  • Parser (src/parser/) - Parse Edges From Callouts, Parse Frontmatter, Parse Rel Links
  • Schema (src/schema/) - Graph Schema Loader
  • 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
  • Unresolved Link (src/unresolvedLink/) - Handler, Link Helpers, Adopt Helpers
  • Vocabulary (src/vocab/) - Vocabulary, Vocabulary Loader, Parse Edge Vocabulary

✅ Funktionen & Features

  • Note-Erstellung - Mit Profilen, Frontmatter-Generierung
  • Interview-Wizard - Steps, Loops, Nested Loops, Section-basierte Ausgabe
  • Semantic Mapping - Builder, Extractor, Edge Type Assignment
  • Chain Inspector - Template Matching, Findings Generation
  • Fix Findings - Automatische Behebung von Findings
  • Unresolved Link Handling - Reading View, Editor, Note Adoption
  • Edge-Type-Änderung - Kontext-Erkennung, Edge Type Selector
  • Graph Export - JSON-Export
  • Linting - Lint Engine mit Regeln
  • Live-Reload - Automatisches Neuladen von Config-Dateien

✅ Commands

  • mindnet-reload-edge-vocabulary - Edge Vocabulary neu laden
  • mindnet-validate-current-note - Note validieren (Lint)
  • mindnet-export-graph - Graph exportieren
  • mindnet-show-chains-from-current-note - Ketten von aktueller Note zeigen
  • mindnet-create-note-from-profile - Note mit Profil erstellen
  • mindnet-change-edge-type - Edge-Type ändern
  • mindnet-debug-chain-roles - Chain Roles Debug-Info
  • mindnet-debug-chain-templates - Chain Templates Debug-Info
  • mindnet-fix-findings - Findings beheben
  • mindnet-inspect-chains - Chains analysieren
  • mindnet-build-semantic-mappings - Semantic Mapping Blöcke bauen

✅ Event Handler

  • Vault Modify Event - Live-Reload von Config-Dateien
  • Vault Create Event - Note Adoption
  • Markdown Post Processor - Unresolved Link Handling (Reading View)
  • DOM Click Event - Unresolved Link Handling (Editor)

✅ Settings

  • Pfad-Settings (6) - Alle Config-Datei-Pfade
  • Graph & Chain Settings (4) - maxHops, strictMode, showCanonicalHints, chainDirection
  • Interview Settings (1) - autoStartInterviewOnCreate
  • Unresolved Link Settings (6) - interceptUnresolvedLinkClicks, autoStartOnUnresolvedClick, bypassModifier, editorFollowModifier, waitForFirstModifyAfterCreate, waitForModifyTimeoutMs, debugLogging
  • Note Adoption Settings (4) - adoptNewNotesInEditor, adoptMaxChars, adoptConfirmMode, highConfidenceWindowMs
  • Semantic Mapping Settings (6) - mappingWrapperCalloutType, mappingWrapperTitle, mappingWrapperFolded, defaultEdgeType, unassignedHandling, allowOverwriteExistingMappings, defaultNotesFolder
  • Inline Micro Edge Suggester Settings (3) - inlineMicroEnabled, inlineMaxAlternatives, inlineCancelBehavior
  • Export Settings (1) - exportPath
  • Chain Inspector Settings (3) - chainInspectorIncludeCandidates, chainInspectorMaxTemplateMatches, templateMatchingProfile
  • Fix Actions Settings (5) - createMissingNote (mode, defaultTypeStrategy, includeZones), createMissingHeading (level), promoteCandidate (keepOriginal)

✅ Konfigurationsdateien

  • edge_vocabulary.md - Format, Parsing-Regeln, Beispiel
  • graph_schema.md - Format, Parsing-Regeln, Beispiel
  • interview_config.yaml - Format, Felder, Beispiel (Profile, Steps, Loops)
  • chain_roles.yaml - Format, Felder, Beispiel (Roles, Edge Types)
  • chain_templates.yaml - Format, Felder, Beispiel (Templates, Slots, Links, Defaults, Profiles)
  • analysis_policies.yaml - Geplante Struktur (noch nicht vollständig implementiert)

✅ Wirkungsweise

  • Live-Reload - Debounced (200ms), Last-Known-Good Fallback
  • Config-Loading - YAML/Markdown Parsing, Error Handling
  • Template Matching - Slot-basiertes Matching, Link Constraints
  • Findings Generation - Gap-Heuristiken, Severity-Policy
  • Note Adoption - Confidence-Evaluation, Adoption-Flow
  • Unresolved Link Handling - Reading View vs Editor, Modifier-Keys
  • 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

Konfiguration

→ 02_Administratorhandbuch.md
→ 06_Konfigurationsdateien_Referenz.md

Nutzung

→ 01_Benutzerhandbuch.md
→ 07_Event_Handler_Commands.md

Entwicklung

→ 03_Entwicklerhandbuch.md
→ 04_Architektur.md

Ende des Dokumentations-Index