munin/internal/hilfe/seiten/weboberflaeche.md
Thomas Adamek cf35c3f5db Verwandte Einträge, Aktualität, Importer (Ausbaustufen 3.7, 3.5, 3.2)
- 3.7: MCP-Werkzeug "related" liefert Nachbarn im Verweisgraphen in beide
  Richtungen, bis zur zweiten Reihe (store.RelatedEntries).
- 3.5: Einträge, die seit über einem Jahr unverändert sind, tragen in
  recall/get/list/related "stale": true; get und recall geben einen
  Hinweis, die Eintragsseite eine Marke. instructions erklären das Feld.
- 3.2: Import von Markdown-Dateien als ZIP unter /p/{projekt}/import
  (Rolle admin), mit Vorschau, überspringen/überschreiben, Erkennung von
  Unverändertem und Papierkorb. Neue Einträge behalten Autor, Herkunft,
  Prüfvermerk und Zeitstempel aus dem Export.

Nebenbei behoben: Das 1-MB-Body-Limit für Formulare lag über dem ganzen
Mux und begrenzte damit auch /mcp auf 1 MB statt MAX_API_BODY_BYTES.
LimitBodies wählt die Grenze jetzt einmal außen je Route.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 08:18:47 +02:00

183 lines
7.4 KiB
Markdown

Die Weboberfläche ist der Zugang für Menschen. Sie zeigt dasselbe Wissen, das
auch die Agenten sehen.
## Anmelden
Angemeldet wird mit dem API-Key des Projekts, also demselben, den auch das
KI-Werkzeug benutzt. Einen Benutzernamen gibt es nicht: Der Key bestimmt, wer
du bist, in welchem Projekt du arbeitest und was du darfst. Wird der Key
zurückgezogen, endet auch die Sitzung im Browser sofort.
## Finden
- **Suchen:** Das Suchfeld über der Eintragsliste durchsucht Titel,
Schlagworte und Inhalt. Titel zählen am stärksten. Umlaute sind egal:
„Uberblick“ findet auch „Überblick“. Ein Wortanfang reicht, „deploy“ findet
auch „Deployment“.
- **Nach Schlagwort filtern:** In der Seitenleiste stehen alle Schlagworte des
Projekts, die häufigsten zuerst. Ein Klick filtert die Liste.
- **Verweisen folgen:** Unter jedem Eintrag steht, welche anderen Einträge auf
ihn verweisen.
- **Graph:** Unter *Graph* in der Seitenleiste zeigt Munin, wie die Einträge
über Verweise zusammenhängen. Gestrichelte Knoten sind Verweisziele, zu denen
es noch keinen Eintrag gibt. Mausrad zoomt, Ziehen verschiebt, ein Klick
öffnet den Eintrag. Bei sehr großen Projekten zeigt der Graph nur die 150 am
stärksten verknüpften Einträge.
## Schreiben
Mit der Rolle `write` oder `admin` gibt es über der Liste den Knopf
**Neuer Eintrag** und in jedem Eintrag **Bearbeiten**.
| Feld | Bedeutung |
|---|---|
| Titel | Worum es geht, am besten als Frage oder klares Thema |
| Bezeichner | Der dauerhafte Name, siehe [Begriffe](/hilfe/begriffe). Leer lassen, dann wird er aus dem Titel abgeleitet. |
| Schlagworte | Durch Komma getrennt. Möglichst vorhandene wiederverwenden. |
| Inhalt | Markdown (siehe unten) |
| Kuratiert | Haken setzen, wenn der Inhalt geprüft und verlässlich ist |
**Bevor du einen neuen Eintrag anlegst**, such kurz, ob es das Thema schon gibt.
Ergänzen ist fast immer besser als ein zweiter Eintrag.
### Markdown im Inhalt
Unterstützt werden die üblichen Auszeichnungen:
```markdown
## Zwischenüberschrift
Normaler Text mit **fett**, *kursiv* und `Code`.
- Aufzählung
- noch ein Punkt
1. Nummerierte Schritte
2. zweiter Schritt
[Ein Link](https://example.org)
Siehe auch [[anderer-eintrag]].
```
Dazu kommen die Erweiterungen, die man von GitHub oder GitLab kennt:
```markdown
| Umgebung | Adresse |
|----------|----------------|
| Test | test.intern |
| Prod | prod.intern |
- [x] erledigt
- [ ] noch offen
~~veraltet~~ — durchgestrichen
https://example.org wird ohne Klammern zum Link.
```
Codeblöcke stehen zwischen drei Backticks. Eingebettetes HTML wird aus
Sicherheitsgründen nicht ausgeführt.
### Verweise mit Autovervollständigung
Tippe `[[` in das Inhaltsfeld. Munin schlägt passende Einträge vor. Mit den
Pfeiltasten auswählen und mit Enter oder Tab übernehmen, oder einfach anklicken.
Eingefügt wird der Bezeichner, nicht der Titel.
### Vorschau
Über dem Inhaltsfeld wechselst du zwischen **Schreiben** und **Vorschau**. Die
Vorschau zeigt den Eintrag genau so, wie er nach dem Speichern aussehen wird.
### Wenn jemand gleichzeitig ändert
Hat jemand anderes (ein Mensch oder ein Agent) den Eintrag geändert, während du
ihn bearbeitet hast, meldet Munin beim Speichern einen Konflikt, statt die
fremde Änderung zu überschreiben. Dein Text bleibt im Formular erhalten. Öffne
den Eintrag in einem zweiten Tab, übernimm dort deine Änderungen in den
aktuellen Stand und speichere dann dort.
## Verlauf und Vergleich
In jedem Eintrag führt **Fassung n, Verlauf ansehen** zu allen früheren
Fassungen. Bei jeder Fassung zeigt **Änderungen ansehen** Zeile für Zeile, was
sich zur nächsten Fassung geändert hat. So lässt sich nachvollziehen, was ein
Agent geändert hat.
Mit Schreibrecht holt **Wiederherstellen** (im Verlauf oder auf der
Vergleichsseite) eine alte Fassung mit einem Klick zurück: Titel, Inhalt und
Schlagworte. Dabei geht nichts verloren — der bisherige Stand wird selbst zu
einer Fassung im Verlauf, und das Protokoll vermerkt, welche Fassung
zurückgeholt wurde. Hat jemand den Eintrag geändert, während du den Verlauf
angesehen hast, wird nichts überschrieben; prüfe dann den neuen Stand und
versuche es erneut.
## Papierkorb
**Löschen** legt einen Eintrag in den Papierkorb, egal ob ein Mensch in der
Oberfläche löscht oder ein Agent über `forget`. Der Eintrag verschwindet sofort
aus Liste, Suche, Graph und allen Antworten an Agenten. Mit Verlauf und
Schlagworten bleibt er aber 30 Tage erhalten; danach entfernt Munin ihn
endgültig.
Den Papierkorb findest du mit Schreibrecht in der Seitenleiste. Dort steht zu
jedem Eintrag, wer ihn wann gelöscht hat:
- **Wiederherstellen** holt einen Eintrag unverändert zurück.
- **Endgültig löschen** entfernt ihn sofort, samt Verlauf. Das ist gedacht für
Inhalte, die nicht 30 Tage liegen bleiben sollen, etwa ein versehentlich
abgelegtes Passwort. Rückgängig machen lässt sich das nicht.
- Ein Klick auf den **Namen eines Zugangs** zeigt nur, was dieser gelöscht hat.
Hat ein Agent zu gründlich aufgeräumt, holt *Alle … wiederherstellen* alles
auf einmal zurück.
Wer mit Leserecht angemeldet ist, sieht den Papierkorb nicht. Oft wird ein
Eintrag ja gerade deshalb gelöscht, weil nicht jeder ihn sehen soll.
Legst du einen Eintrag mit einem Bezeichner an, der noch im Papierkorb liegt,
holt Munin den alten Eintrag zurück und überschreibt ihn. Der gelöschte Stand
steht dann im Verlauf, und ein Hinweis sagt dir, dass das passiert ist.
Veraltetes trotzdem lieber überarbeiten als löschen: Überarbeitetes bleibt
auffindbar, und der Verlauf zeigt, was sich geändert hat.
## Viele Einträge auf einmal
Mit Schreibrecht hat die Eintragsliste vor jedem Eintrag ein Auswahlkästchen.
Unter der Liste lassen sich für alle ausgewählten Einträge Schlagworte
hinzufügen oder entfernen, mehrere durch Komma getrennt. Praktisch, um ein
Schlagwort umzubenennen: das neue hinzufügen, das alte entfernen.
## Import
Mit der Rolle `admin` gibt es in der Seitenleiste den Punkt *Import*. Dort
lässt sich ein ZIP-Archiv mit Markdown-Dateien hochladen. Jede Datei wird ein
Eintrag. Das passt für drei Fälle:
- **Wiederherstellen** aus dem Markdown-Export: den Ordner eines Projekts
packen und hochladen. Schlagworte, Autor, Herkunft, Prüfvermerk und
Änderungsdatum bleiben erhalten.
- **Umzug** eines Projekts auf einen anderen Server oder in einen anderen
Workspace, auf demselben Weg.
- **Vorhandene Dokumentation** übernehmen. Der Bezeichner kommt aus dem
Dateinamen, der Titel aus der ersten Überschrift `# …`. Unterordner sind
erlaubt, im Projekt stehen die Einträge danach aber nebeneinander.
Gibt es einen Bezeichner schon, wird die Datei entweder **übersprungen**
(Standard) oder sie **überschreibt** den Eintrag. Beim Überschreiben wandert
der bisherige Stand in den Verlauf, verloren geht also nichts. Dateien, die
nichts ändern würden, werden in beiden Fällen nicht geschrieben. Derselbe
Import lässt sich deshalb gefahrlos wiederholen.
**Nur Vorschau** ist beim ersten Hochladen angehakt. Die Tabelle zeigt dann
für jede Datei, was passieren würde, ohne etwas zu schreiben. Passt alles,
dasselbe Archiv ohne den Haken noch einmal hochladen.
Nicht übernommen wird der Verlauf, denn der Export enthält nur den aktuellen
Stand. Ein importierter Eintrag beginnt deshalb wieder bei Fassung 1.
## Protokoll
Unter *Protokoll* in der Seitenleiste steht, wer im Projekt wann etwas
geschrieben, gelöscht oder sich angemeldet hat.