Initial release: Plenty Dojo Wissensbasis
Geteilte Plentymarkets API Learnings (DOJO.md, ANTI-PATTERNS.md), Claude Code Skill (/plenty-dojo), und Install-Script für neue User.
This commit is contained in:
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# Plenty Dojo
|
||||
|
||||
Gesammelte Lektionen aus der Arbeit mit der **Plentymarkets REST API** — von AI-Agenten für AI-Agenten.
|
||||
|
||||
Dieses Repo ist eine geteilte Wissensbasis, die Claude Code (oder andere AI-Coding-Agenten) beim Arbeiten mit Plentymarkets nutzen und erweitern.
|
||||
|
||||
## Was ist drin?
|
||||
|
||||
| Datei | Inhalt | Geteilt? |
|
||||
|-------|--------|----------|
|
||||
| `DOJO.md` | Allgemeine API-Patterns & Lektionen | Ja |
|
||||
| `ANTI-PATTERNS.md` | Was man NICHT tun soll | Ja |
|
||||
| `instances/<PID>.md` | Shop-spezifische Lektionen (Status, IDs, Workflows) | Nein (gitignored) |
|
||||
|
||||
## Installation
|
||||
|
||||
### 1. Repo klonen
|
||||
|
||||
```bash
|
||||
git clone <REPO-URL> ~/.claude/plenty-dojo
|
||||
```
|
||||
|
||||
### 2. Install-Script ausführen
|
||||
|
||||
```bash
|
||||
bash ~/.claude/plenty-dojo/install.sh
|
||||
```
|
||||
|
||||
Das Script:
|
||||
- Symlinkt den Skill nach `~/.claude/commands/plenty-dojo.md`
|
||||
- Erstellt `instances/` mit einer Vorlage für deine Plenty-ID
|
||||
|
||||
### 3. Plenty-ID eintragen
|
||||
|
||||
Öffne `~/.claude/plenty-dojo/instances/<DEINE-PID>.md` und trage deine shop-spezifischen Learnings ein. Diese Datei wird nicht ins geteilte Repo gepusht.
|
||||
|
||||
### 4. CLAUDE.md ergänzen
|
||||
|
||||
Füge in die `CLAUDE.md` deines Projekts (oder global in `~/.claude/CLAUDE.md`) ein:
|
||||
|
||||
```markdown
|
||||
## Plenty Dojo
|
||||
- Vor jeder Plenty-Integration die Dojo-Dateien lesen:
|
||||
- `~/.claude/plenty-dojo/DOJO.md`
|
||||
- `~/.claude/plenty-dojo/ANTI-PATTERNS.md`
|
||||
- `~/.claude/plenty-dojo/instances/<DEINE-PID>.md` (falls vorhanden)
|
||||
- Nach jedem Bugfix prüfen, ob ein neues Learning ins Dojo gehört (`/plenty-dojo lernen`).
|
||||
```
|
||||
|
||||
## Nutzung
|
||||
|
||||
Der Skill wird über Claude Code aufgerufen:
|
||||
|
||||
| Befehl | Was passiert |
|
||||
|--------|-------------|
|
||||
| `/plenty-dojo` oder `/plenty-dojo lernen` | Analysiert die aktuelle Konversation und schlägt neue Einträge vor |
|
||||
| `/plenty-dojo zeigen` | Zeigt alle Einträge mit Statistik |
|
||||
| `/plenty-dojo suchen <begriff>` | Durchsucht alle Dojo-Dateien |
|
||||
| `/plenty-dojo sync` | Holt neue Einträge von anderen und pusht eigene |
|
||||
|
||||
## Beitragen
|
||||
|
||||
Direkt in `DOJO.md` oder `ANTI-PATTERNS.md` schreiben und pushen. Jeder Eintrag hat:
|
||||
|
||||
- **Überschrift** mit fortlaufender Nummer
|
||||
- **Lektion** — ein Satz
|
||||
- **Warum** — was genau passiert ist
|
||||
- **Pattern** — Codebeispiel (richtig)
|
||||
- **Anti-Pattern** — Codebeispiel (falsch)
|
||||
- **Entdeckt** — Datum + Kontext
|
||||
|
||||
Der `/plenty-dojo lernen` Befehl hilft beim Formulieren und Einordnen.
|
||||
Reference in New Issue
Block a user