Dashboard

Was du bekommst

Das Dashboard gibt deinem Team eine gemeinsame URL für den Verlauf von Agent Note.

• Offene und gemergte PRs an einem Ort
• Commits, Prompts und Attribution ohne jede PR einzeln zu öffnen
• Reinen Anzeige-📝 Context vor kurzen Prompts sehen, wenn Agent Note Referenz oder Scope wiederherstellen kann
• Eine gemeinsame GitHub Pages URL, normalerweise unter /dashboard/

Nutze es, wenn ein PR-Report allein nicht reicht und dein Team eine gemeinsame Übersicht braucht.

Bevor du startest

Das Dashboard brauchst du nur, wenn du eine gemeinsame Web-Ansicht möchtest.

• Wenn euch AI-Sitzungsberichte direkt in Pull Requests reichen, bleib bei GitHub Action.
• Wenn ihr offene und gemergte Historie gemeinsam sehen wollt, geht es hier weiter.

Schnellstart

1. Führe das Dashboard-Setup einmal aus.

npx agent-note init --agent claude --dashboard

2. Committe beide Workflow-Dateien.

git add .github/workflows/agentnote-pr-report.yml .github/workflows/agentnote-dashboard.yml
git commit -m "chore: enable agent-note dashboard"
git push

3. Wähle in GitHub Pages GitHub Actions als Quelle.

Der generierte Dashboard-Workflow verwendet wasabeef/AgentNote@v1 mit dashboard: true, um Wiederherstellung, Sync, Build, Artefakt-Upload und Notes-Persistenz auszuführen, und veröffentlicht danach die gemeinsame Ansicht unter /dashboard/. Wenn derselbe Job bereits ein GitHub-Pages-Artefakt hochlädt, fügt Agent Note das Dashboard unter dashboard/ in dieses Artefakt ein, statt die bestehende Site zu ersetzen. Wenn ein anderer Job oder Workflow Pages bereits veröffentlicht, überspringt Agent Note die Standalone-Veröffentlichung; platziere Agent Note im selben Job vor actions/upload-pages-artifact, um docs site und Dashboard zu kombinieren.

Öffentliche URL

Typischerweise wird das Dashboard hier veröffentlicht:

• https://<owner>.github.io/<repo>/dashboard/

Zum Beispiel:

• https://wasabeef.github.io/AgentNote/dashboard/

Tipp

Wenn du mit GitHub Pages veröffentlichst, übergibt dein Pages-Workflow die repository-spezifischen Werte für SITE und BASE zur Build-Zeit. In den meisten Repositories reicht das Beispiel-Workflow ohne weitere Änderungen am Dashboard source.

Erstes Deploy

Auch ein neues Repository kann schon vor dem ersten Production-Deploy Dashboard-Daten sammeln. Wenn PR-Deploys erlaubt sind, erscheint die öffentliche Pages-URL nach dem ersten erfolgreichen pull_request-Run. Andernfalls erscheint sie nach dem ersten erfolgreichen Deploy von default branch.

Wie es funktioniert

• refs/notes/agentnote bleibt die Source of Truth
• wasabeef/AgentNote@v1 im Dashboard-Modus schreibt Notes-Snapshots nach gh-pages/dashboard/notes/*.json
• GitHub Pages liefert das gebaute Dashboard unter /dashboard/ aus

Das Repository committet keine Beispiel-JSONs für das Dashboard. Ein neues Dashboard bleibt leer, bis der Workflow note files wiederherstellt oder erzeugt. pull_request veröffentlicht den Open-Status, und Pushes auf default branch ersetzen ihn durch den Merged-Status.

Wenn keine Daten angezeigt werden

Das Dashboard zeigt jetzt konkrete Hinweise, statt nur zu sagen, dass Daten fehlen.

• Gar keine Daten: Prüfe, ob nach dem Aktivieren von Agent Note ein PR-Workflow gelaufen ist, der Dashboard-Workflow erfolgreich war und refs/notes/agentnote gepusht wurde.
• ?pr=<number> zeigt nichts: Der Workflow für diese PR ist vielleicht noch nicht gelaufen, Pull Request Deploys können durch GitHub Pages environment protection blockiert sein, oder die PR-Nummer passt nicht zu den veröffentlichten Dashboard-Daten.
• ?commit=<sha> zeigt nichts: Der Commit hat möglicherweise keinen Agent Note Eintrag, notes wurden noch nicht gepusht, oder der SHA stammt aus einem anderen Repository.

Wenn die Seite öffnet, aber leer bleibt, siehe Troubleshooting.