Add AI repo README
This commit is contained in:
1 parent
7ac52911fd
commit
e5535d443b
1 file changed
+59
@@ -0,0 +1,59 @@
|
||||
# AI README
|
||||
|
||||
Diese Datei ist fuer AI-Agenten gedacht, die in diesem Repo weiterarbeiten.
|
||||
|
||||
## Repo-Zweck
|
||||
|
||||
Dieses Repo ist der Obsidian-/Wireframe-Vault fuer HiveGrid. Es enthaelt Planung, UX-Regeln, Screen-Pakete, Canvas-Flows und Subframe-Handoffs. Es ist nicht die Produkt-Codebase.
|
||||
|
||||
Die eigentliche Referenz-Codebase liegt lokal in `hivegrid-cloud/` und ist bewusst per `.gitignore` ausgeschlossen. Dieses Verzeichnis darf gelesen werden, soll aber nicht in dieses Wireframe-Repo committed oder gepusht werden.
|
||||
|
||||
## Wichtige Bereiche
|
||||
|
||||
| Pfad | Zweck |
|
||||
|---|---|
|
||||
| `00 Start Here.md` | Einstieg in den Vault |
|
||||
| `01 Regeln/` | Arbeitsregeln fuer Wireframing, Obsidian, Subframe und Brainstorming |
|
||||
| `02 Wireframes/Screen Paket Tracker.md` | Zentrale Paket- und Flow-Uebersicht |
|
||||
| `02 Wireframes/P2 Auth/` | Aktuell aktive Auth-/Account-/Admin-Wireframe-Pakete |
|
||||
| `02 Wireframes/_Templates/` | Vorlagen fuer neue Pakete und Screens |
|
||||
| `03 Quellen und Repo/` | Repo- und Quellenhinweise |
|
||||
|
||||
## Arbeitsregeln
|
||||
|
||||
- Bestehende Regeln zuerst lesen, besonders `01 Regeln/Wireframing Playbook.md`.
|
||||
- Flows einzeln bearbeiten und nur validierte Entscheidungen final dokumentieren.
|
||||
- Keine bestehenden Subframe-Screens loeschen oder ueberschreiben, wenn der Nutzer das nicht explizit verlangt.
|
||||
- Neue Screens/Flows immer in Tracker, Paketdatei, Screen-Dateien und Canvas konsistent halten.
|
||||
- Backlog-Punkte klar markieren, damit V2-Themen nicht verloren gehen.
|
||||
- Bei Subframe-Arbeit bestehende Nutzer-Anpassungen nicht rueckgaengig machen.
|
||||
- `hivegrid-cloud/` nur als Referenz verwenden.
|
||||
|
||||
## Subframe-Kontext
|
||||
|
||||
Subframe-Links stehen in den jeweiligen Screen-Dateien im Frontmatter-Feld `subframe`. Bei Modal-Screens soll, wenn moeglich, die echte Subframe-Modal-/Dialog-Layout-Funktion verwendet werden, nicht ein nachgebautes Overlay.
|
||||
|
||||
## Git- und Sync-Regel
|
||||
|
||||
Dieses Repo soll haeufig committed und gepusht werden, damit die Planung fuer andere Agents und Menschen synchron bleibt.
|
||||
|
||||
Empfohlener Rhythmus:
|
||||
|
||||
1. Nach abgeschlossenem Flow-/Screen-Paket committen.
|
||||
2. Nach wichtigen Nutzer-Validierungen committen.
|
||||
3. Nach laengeren Subframe- oder Canvas-Aenderungen pushen.
|
||||
|
||||
Standardbefehle:
|
||||
|
||||
```bash
|
||||
git status --short
|
||||
git add .
|
||||
git commit -m "Update wireframe planning"
|
||||
git push
|
||||
```
|
||||
|
||||
Vor jedem Commit pruefen, dass `hivegrid-cloud/` nicht staged ist.
|
||||
|
||||
## Aktueller Remote
|
||||
|
||||
Das Repo soll nach `git.tool-ctrl.de/david/Hivegrid-Wireframes` gepusht werden. Falls Push nicht funktioniert, liegt es wahrscheinlich an SSH-/HTTPS-Zugriff oder Server-Port-Konfiguration, nicht an der lokalen Repo-Struktur.
|
||||
Reference in new issue
Block a user