Skip to content

README.md

Latest commit

 

History

History
136 lines (91 loc) · 3.78 KB

README.md

File metadata and controls

136 lines (91 loc) · 3.78 KB

📚 Documentação DiaryMCP v2

Documentação completa do DiaryMCP - Sistema federado de diary de desenvolvimento.

🚀 Começar

Novo no DiaryMCP? Comece aqui:

  1. QUICK_START.md - Instalação e primeiros passos (10 min)
  2. CONFIGURACAO.md - Configure LLMs e credenciais

📖 Guias de Uso

Features Principais

Referência

📁 Estrutura da Documentação

docs/
├── README.md              ← Você está aqui
├── QUICK_START.md         ← Comece por aqui!
├── CONFIGURACAO.md        ← LLMs, credenciais, variáveis
├── AUTO_CAPTURE.md        ← Git hooks + daemon
├── BUSCA_SEMANTICA.md     ← Busca local
├── ARQUITETURA.md         ← Como o sistema funciona
├── ROADMAP.md             ← Próximas features
└── _obsoleto/             ← Docs antigas (referência)

🎯 Fluxos Comuns

"Quero começar a usar agora"

# 1. Leia o quick start
cat docs/QUICK_START.md

# 2. Instale no projeto
./local/install.sh

# 3. Configure API key (opcional)
nano .diary/config/credentials.yaml

# 4. Teste
.diary/capture.sh "primeiro teste"
.diary/search.sh --index

"Como configurar GPT-4o-mini?"

→ Veja CONFIGURACAO.md seção "Configuração de LLMs"

"Como funciona o auto-capture?"

→ Veja AUTO_CAPTURE.md

"Como buscar capturas antigas?"

→ Veja BUSCA_SEMANTICA.md

"Quero entender a arquitetura"

→ Veja ARQUITETURA.md

"O que vem a seguir no projeto?"

→ Veja ROADMAP.md

🔍 Busca Rápida

Tópico Documento Seção
Instalar no projeto QUICK_START.md "Instalação em 3 Passos"
OpenAI API key CONFIGURACAO.md "Configuração de LLMs"
OpenRouter CONFIGURACAO.md "Providers Suportados"
Git hooks AUTO_CAPTURE.md "Modo 1: Git Hooks"
Daemon AUTO_CAPTURE.md "Modo 2: Daemon"
CLI de busca BUSCA_SEMANTICA.md "Uso Básico"
Indexar entradas BUSCA_SEMANTICA.md "--index"
Custos LLM CONFIGURACAO.md "Estimativa de Custos"
Troubleshooting CONFIGURACAO.md "Troubleshooting"

💡 Dicas

  • Primeira vez? Siga o QUICK_START.md passo-a-passo
  • Erros? Veja seção Troubleshooting em CONFIGURACAO.md
  • Offline? Todas as features principais funcionam sem internet
  • Sem API key? Sistema usa heurísticas básicas (gratuito)

📝 Notas

Arquivos Obsoletos

Documentação antiga foi movida para _obsoleto/:

  • v2.md - Substituído por ARQUITETURA.md (mais enxuto)
  • PLANEJAMENTO_PROXIMOS_SPRINTS.md - Substituído por ROADMAP.md
  • CONFIGURACAO_LLMS.md, VARIAVEIS_AMBIENTE.md, etc. - Consolidados em CONFIGURACAO.md

Mantidos apenas para referência histórica.

Idioma

  • Código: Inglês
  • Documentação: Português (majoritariamente)
  • Comentários: Português

Padronização completa planejada para futuro (veja ROADMAP.md).

🤝 Contribuindo

Encontrou erro na documentação? Ajude a melhorar:

  1. Abra issue descrevendo o problema
  2. Ou submeta PR com correção
  3. Mantenha o estilo: claro, conciso, exemplos práticos

❓ Ainda com Dúvidas?

  1. Busque neste README
  2. Leia o guia específico (links acima)
  3. Veja Troubleshooting em CONFIGURACAO.md
  4. Abra issue no GitHub

Versão da Documentação: v2.1.0 Última Atualização: 2025-01-28