mindnet_obsidian/docs/readme.md
Lars 0fa2197ab2
Some checks are pending
Node.js build / build (20.x) (push) Waiting to run
Node.js build / build (22.x) (push) Waiting to run
Doku MVP1.0
2026-01-17 10:56:59 +01:00

46 lines
1.8 KiB
Markdown

# README — Mindnet Obsidian Plugin (MVP 1.0)
## Überblick
Das Mindnet Obsidian Plugin ist ein Authoring-Tool, das dich dabei unterstützt:
- Mindnet-Notes strukturiert anzulegen (Frontmatter, IDs, Typen)
- Inhalte über konfigurierbare Interviews zu erfassen
- semantische Kanten (Edges) zu pflegen und zu validieren
- Links und Edge-Zuordnungen innerhalb einer Note section-basiert zu gruppieren (Semantic Mapping)
## Hauptkonzepte
- **Profile**: Auswahl eines “Erstell-Profils” (kann mehrere Interviews pro Note-Typ geben).
- **Interview Config (YAML)**: definiert Steps, Loops, Defaults, Frontmatter-Whitelist.
- **ID-first**: Mindnet-Graph arbeitet über Frontmatter `id` als Schlüssel.
- **Semantic Mapping**: links in einer Section werden Edge-Typen zugeordnet und als Callouts strukturiert.
## Quickstart (User)
1) Plugin installieren (siehe Handbuch: Deployment)
2) Settings:
- `edge_vocabulary path` setzen
- `graph_schema path` setzen
- `interview_config path` setzen
3) Neue Note:
- Command: **Mindnet: Create note from profile**
- Profil wählen, Titel setzen, Folder wählen
- Wizard ausfüllen, Finish
- Edger läuft optional post-run und baut Semantic Mapping Blöcke
## Commands (Auszug)
- Create/Interview:
- Mindnet: Create note from profile
- (Auto) Start Wizard nach Create (konfigurierbar)
- Mapping/Edges:
- Mindnet: Build semantic mapping blocks (by section)
- Mindnet: Reload edge vocabulary
- (post-run) Edger nach Interview Finish
- QA:
- Mindnet: Validate current note (Lint)
- Export/Graph:
- Mindnet: Export graph (JSON)
- Mindnet: Show chains from current note
## Konfigurationsdateien (typisch im Vault)
- `_system/dictionary/edge_vocabulary.md`
- `_system/dictionary/graph_schema.md`
- `_system/dictionary/interview_config.yaml`