3.8 KiB
3.8 KiB
HANDBUCH — Mindnet Obsidian Plugin (MVP 1.0)
1) Installation / Deployment (Neu aus Gitea)
Dieses Kapitel beschreibt den Prozess, wenn du das Plugin komplett neu aus Gitea holst und in Obsidian bereitstellst.
1.1 Voraussetzungen
- Windows (Entwicklung) + Obsidian Desktop
- Node.js installiert (CLI verfügbar)
- Falls PowerShell
npmblockiert:npm.cmdnutzen
- Falls PowerShell
- Git Zugriff auf dein Gitea Repo
1.2 Repo klonen
Beispiel:
- Ordner wählen (z.B.
C:\Dev\cursor\mindnet_obsidian) - Repo klonen:
git clone <gitea-url> mindnet_obsidian
- In den Ordner wechseln:
cd mindnet_obsidian
1.3 Dependencies installieren
Wenn PowerShell npm-scripts blockiert:
- nutze
npm.cmd install
Standard:
npm install
1.4 Build
npm run build
Erwartetes Ergebnis:
- Plugin-Bundle (typischerweise
main.js) wird erzeugt (abhängig von eurer Build-Konfiguration).
1.5 Deployment in einen Obsidian Vault (Dev)
Zielpfad:
<vault>/.obsidian/plugins/<plugin-id>/
Schritte:
- Im Vault sicherstellen:
.obsidian/plugins/existiert
- Plugin-Ordner anlegen:
.obsidian/plugins/mindnet-causal-assistant/
- Deployment (Copy):
manifest.json→ plugin foldermain.js→ plugin folder- optional
styles.css→ plugin folder
Wenn ihr ein Script habt (empfohlen):
powershell -ExecutionPolicy Bypass -File scripts\deploy-local.ps1
1.6 Plugin aktivieren
Obsidian:
- Settings → Community Plugins
- “Restricted mode” aus
- Plugin aktivieren
1.7 Typische Fehlerbilder
- “Plugin lädt nicht”:
- Obsidian neustarten
- Plugin disable/enable
- prüfen, ob
main.jsim Plugin-Ordner aktuell ist
- Keine Logs:
- DevTools öffnen:
Ctrl+Shift+I - Console Filter zurücksetzen
- DevTools öffnen:
2) Konfiguration (Pfad-Settings)
2.1 Vocabulary
edge_vocabulary path(z.B._system/dictionary/edge_vocabulary.md)- Live reload bei Dateiänderung (debounced)
2.2 Graph Schema
graph_schema path(z.B._system/dictionary/graph_schema.md)- Wird für Empfehlungen (typical/prohibited) verwendet
2.3 Interview Config
interview_config path(z.B._system/dictionary/interview_config.yaml)- Profiles definieren Note-Type, Defaults, Steps, Loop-Layouts
3) Workflows
3.1 Note erstellen
- Command: “Create note from profile”
- Profil wählen
- Titel setzen
- Folder wählen (oder default)
- Note wird erstellt und geöffnet
3.2 Interview durchführen
- Wizard startet automatisch (wenn aktiviert) oder manuell per Command
- Steps ausfüllen (Loops/Nested Loops möglich)
- Review → Apply & Finish
- Output wird geschrieben
3.3 Semantic Mapping (Edger)
Manuell:
- Command: “Build semantic mapping blocks (by section)”
Automatisch (post-run):
- Nach Interview Finish wird der Edger ausgeführt (falls im Profil aktiviert)
Output:
- pro Section ein Mapping-Block am Ende der Section:
- Wrapper callout (Default: abstract)
- gruppiert nach Edge-Typ
- Gruppen getrennt durch Leerzeile
3.4 Unresolved Link → Interview
- Klick auf
[[Neue Note]] - In Reading View: Plugin übernimmt Flow
- In Editing View: Obsidian kann Note sofort erzeugen → Plugin “adoptiert” und startet Mindnet Flow
4) Entwicklung (Dev-Workflow)
4.1 Build + Deploy lokal
npm run buildscripts\deploy-local.ps1ausführen (falls vorhanden)- Obsidian: Plugin reload (disable/enable)
4.2 Tests
npm run test
5) Troubleshooting
- Wizard startet nicht:
- Prüfe settings
autoStart... - DevTools Console auf Fehler prüfen
- Prüfe settings
- Edger schreibt Blöcke an falscher Stelle:
- Prüfe Heading Parsing + Section detection
- Prüfe, ob Wrapper Block korrekt erkannt/ersetzt wird
- Schema Empfehlungen fehlen:
- Prüfe graph_schema path
- Prüfe schema loader stats/logging
CHANGELOG (optional)
- v1.0.0: MVP 1.0 Feature Freeze