Documentação central da plataforma DestaquesGovbr para onboarding de desenvolvedores e colaboradores técnicos.
O DestaquesGovbr é uma plataforma integrada de notícias e informações do Governo Federal Brasileiro que:
- Centraliza ~160+ portais governamentais em uma plataforma única
- Classifica automaticamente notícias usando AI/LLM em 25 temas e 3 níveis hierárquicos
- Disponibiliza dados abertos no HuggingFace (~300k+ notícias)
- Oferece portal web moderno com busca semântica
→ Veja onboarding/setup-backend.md
→ Veja onboarding/setup-frontend.md
→ Veja onboarding/roteiro-onboarding.md
flowchart LR
A[160+ Sites gov.br] -->|Raspagem| B[Scraper]
B -->|Enriquecimento| C[Cogfy/LLM]
C -->|Armazenamento| D[(HuggingFace)]
D -->|Indexação| E[(Typesense)]
E -->|Busca| F[Portal Next.js]
→ Veja detalhes em arquitetura/visao-geral.md
| Repositório | Descrição | Tecnologia |
|---|---|---|
| scraper | Scraper + Pipeline de dados | Python/Poetry |
| portal | Portal web principal | Next.js 15 |
| infra | Infraestrutura como código | Terraform/GCP |
| typesense | Typesense para dev local | Docker |
| agencies | Dados dos órgãos | YAML |
docs/
├── arquitetura/ # Visão geral, fluxo de dados, componentes
├── modulos/ # Detalhes de cada módulo/repositório
├── workflows/ # GitHub Actions, CI/CD, pipelines
├── infraestrutura/ # GCP, Terraform, secrets
├── onboarding/ # Guias para novos desenvolvedores
├── plano/ # Plano de implementação da documentação
└── assets/diagrams/ # Diagramas em Mermaid
- Portal (Preview): portal (URL provisória)
- Dataset Principal: nitaibezerra/govbrnews
- Dataset Reduzido: nitaibezerra/govbrnews-reduced
- Organização GitHub: github.com/destaquesgovbr
Esta documentação foi inteiramente gerada por LLM (Claude Code) usando uma abordagem bottom-up: o código dos repositórios existentes foi analisado para criar uma camada de documentação sobre eles.
Documentamos o processo completo de criação como um guia de boas práticas:
→ Veja plano/PLANO_IMPLEMENTACAO.md
O guia inclui:
- Mindset para estruturar prompts de documentação
- Prompts reais utilizados neste projeto
- Template reutilizável para outros projetos
- Boas práticas aprendidas no processo
→ Veja CONTRIBUTING.md
Mantido pela equipe DestaquesGovbr | Ministério da Gestão e da Inovação em Serviços Públicos