Dashboard

O que você ganha

O Dashboard dá ao time uma URL única para consultar o histórico do Agent Note.

• PRs abertas e mergeadas em um só lugar
• Commits, prompts e attribution sem abrir cada PR
• Ver 📝 Context apenas visual antes de prompts curtos quando o Agent Note recupera referência ou escopo
• Uma única URL do GitHub Pages, normalmente em /dashboard/

Use isso quando o relatório da PR não basta mais e você quer uma visão compartilhada para o time.

Antes de começar

Você só precisa do Dashboard se quiser uma visualização web compartilhada.

• Se os relatórios de sessão de IA dentro das pull requests já bastam, pare em GitHub Action.
• Se quiser uma visão compartilhada no Pages para histórico aberto e mergeado, continue aqui.

Configuração rápida

1. Execute a configuração do Dashboard uma vez.

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

2. Faça commit dos dois arquivos de workflow.

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

3. No GitHub Pages, escolha GitHub Actions como source.

O workflow gerado do Dashboard usa wasabeef/AgentNote@v1 com dashboard: true para restaurar, sincronizar, fazer build, enviar o artefato e persistir as notas, e então publica a visualização compartilhada em /dashboard/. Se o mesmo job já envia um artefato do GitHub Pages, o Agent Note adiciona o Dashboard ao diretório dashboard/ desse artefato em vez de substituir o site existente. Se outro job ou workflow já publica Pages, o Agent Note pula a publicação standalone; coloque Agent Note no mesmo job antes de actions/upload-pages-artifact para combinar docs site e Dashboard.

URL pública

Normalmente o Dashboard é publicado aqui:

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

Por exemplo:

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

Dica

Se você publica com GitHub Pages, o workflow do Pages passa os valores específicos do repositório para SITE e BASE durante o build. Na maioria dos repositórios, o workflow de exemplo já resolve sem mudar o Dashboard source.

Primeiro deploy

Mesmo um repositório novo pode acumular dados do Dashboard antes do primeiro deploy em produção. Se deploys de PR forem permitidos, a URL pública do Pages pode aparecer após o primeiro run pull_request bem-sucedido. Caso contrário, ela aparece após o primeiro deploy bem-sucedido a partir de default branch.

Como funciona

• refs/notes/agentnote continua sendo a Source of Truth
• wasabeef/AgentNote@v1 no modo Dashboard grava snapshots de notas em gh-pages/dashboard/notes/*.json
• O GitHub Pages serve o Dashboard gerado em /dashboard/

O repositório não faz commit de exemplos JSON do Dashboard. Um Dashboard novo fica vazio até que o workflow restaure ou gere os note files. pull_request publica o estado Open, e os pushes para default branch o substituem pelo estado Merged.

Quando os dados não aparecem

O Dashboard agora mostra pistas concretas em vez de apenas dizer que os dados estão ausentes.

• Sem dados: confirme que um workflow de PR rodou depois que o Agent Note foi ativado, que o workflow do Dashboard passou e que refs/notes/agentnote foi enviado.
• ?pr=<number> não mostra dados: o workflow dessa PR pode ainda não ter rodado, Pull Request Deploys podem estar bloqueados pela proteção de ambiente do GitHub Pages, ou o número da PR pode não corresponder aos dados publicados.
• ?commit=<sha> não mostra dados: esse Commit pode não ter uma entrada do Agent Note, as notes podem ainda não ter sido enviadas, ou o SHA pode vir de outro repositório.

Se a página abre mas continua vazia, consulte Troubleshooting.