Dokumentation

Alles hier entsteht aus dem Ordner docs/ des Repositorys, bisher nur auf Englisch. Wer Groundnote zuerst ausprobieren will, folgt dem Schnellstart im README.

Betrieb

Konfiguration: Die Datei groundnote.json, Umgebungsvariablen, Cloudflare Access und Einstellungen zur Datensicherung.
CLI: Alle Befehle der CLI groundnote, doctor und die nächtliche Datensicherung.
Datensicherung: Die Wege, eine Groundnote-Instanz zu sichern, und wie du sie wiederherstellst und prüfst.
Anbieter: Welcher Text an welchen Anbieter geht und welche Bedingungen du vor dem Einschalten lesen solltest.

Wie es arbeitet

Architektur: Der verbindliche Vertrag für Datenmodell, API und Anmeldung.
Freigabemodi: Die Modi A, B und C, wie Vorschläge eingestuft werden, die Pflichtausnahmen und das Zurücknehmen.
Wissensgraph: Entitäten und Verknüpfungen: der Baum, der Regeln und Quellen ihren Platz in einem Bereich gibt.
Lexikalische Suche: Wie Stufe a sucht und was jeder Schritt in den Messungen bringt.
Suchstufen b und c: Lokale Embeddings und der JEV-Prüfer: Einstellungen, Grenzen und ihr Platz in der Suche.
Schwärzung: Der vorgeschlagene Entwurf für Schwärzung, Löschung und verschlüsselte Datensicherung. Noch nicht gebaut.

Für Agenten

Leitfaden für Agenten: Wie ein KI-Agent die MCP-Funktionen und Prompts nutzt, mit vollständigen Beispieldialogen.

Sicherheit

Bedrohungsmodell: Wovor sich Groundnote schützt und wie.
Gespeicherte Daten: Wie gespeicherte Daten und Sicherungen geschützt sind. Ein Entwurf: Löschen ist noch nicht gebaut.

Projekt

Fahrplan: An echten Daten gemessene Vorschläge und was als Nächstes kommt.
Befunde aus der Praxis: Was ein Praxistest mit echten Besprechungen, Mails und Chats gezeigt hat.
Release: Wie eine Version von main zum Image und auf die Release-Seite kommt.
Abweichungen: Wo Groundnote vom ursprünglichen deutschen Vertrag abweicht und warum.
Glossar: Die deutschen Vertragsbegriffe und ihre englischen Namen im Code.
Marke: Das Zeichen, die Farben und die Schrift und wie du sie verwendest.