Doc Agent

Automatiza a atualização de documentação analisando commits com IA. Corre via npx doc-agent — zero ficheiros para copiar para o teu repositório.

Como funciona

push no repo principal → dispatch → repo de docs → npx doc-agent → IA analisa diff → atualiza .md → commit

Quick Start (2 minutos)

1. No repositório de documentação

npx doc-agent --init-docs

Isto gera .github/workflows/doc-agent.yml.

2. No repositório principal (código)

npx doc-agent --init-main

Isto gera .github/workflows/notify-doc-agent.yml.

3. Configurar secrets no GitHub

No repositório de docs, adiciona os secrets necessários:

| Secret | Obrigatório | Descrição | |--------|-------------|-----------| | ANTHROPIC_API_KEY | Sim (se usar Anthropic) | API key da Anthropic | | OPENAI_API_KEY | Se usar OpenAI | API key da OpenAI | | GEMINI_API_KEY | Se usar Gemini | API key do Google Gemini | | TELEGRAM_BOT_TOKEN | Opcional | Para notificações Telegram | | TELEGRAM_CHAT_ID | Opcional | Chat ID do Telegram |

No repositório principal, adiciona:

| Secret | Descrição | |--------|-----------| | DOC_AGENT_TOKEN | PAT com acesso de escrita ao repositório de docs |

4. Editar o notify-doc-agent.yml

Altera NOME-DO-REPO-DOCS na linha repository: para o nome do teu repositório de documentação.

Pronto. No próximo push, a documentação é atualizada automaticamente.

Variáveis de ambiente

| Variável | Default | Descrição | |----------|---------|-----------| | PROVIDER_TYPE | anthropic | anthropic ou openai-compatible | | PROVIDER_MODEL | claude-sonnet-4-20250514 | Modelo a usar | | PROVIDER_BASE_URL | — | URL base para self-hosted (Ollama, vLLM, etc.) | | PROVIDER_MAX_TOKENS | 8000 | Limite de tokens por chamada | | DIFF_MAX_CHARS | 64000 | Limite de caracteres do diff analisado | | PROVIDER_API_KEY | — | Fallback genérico para API key | | DOC_AGENT_CONFIG_PATH | — | Caminho para config file opcional |

Providers suportados

Provider customizado via .doc-agent/config.json (opcional, na raiz do repo de docs):

{
  "defaultProvider": "gemini",
  "providers": {
    "gemini": {
      "type": "openai-compatible",
      "model": "gemini-2.0-flash",
      "baseUrl": "https://generativelanguage.googleapis.com/v1beta/openai"
    }
  }
}

As API keys nunca ficam no ficheiro — são resolvidas de env vars (GEMINI_API_KEY, MISTRAL_API_KEY, etc.).