📚 Documentação.dev

Plataforma de documentação técnica de alta qualidade em Português do Brasil

📋 Status das Traduções

✅ Disponíveis

🔄 Em Processo

🔜 Em Breve

🌟 Sobre o Projeto

O Documentação.dev é uma iniciativa da comunidade brasileira para traduzir documentações técnicas de frameworks e tecnologias para o Português do Brasil. Acreditamos que quebrar a barreira do idioma é essencial para democratizar o acesso ao conhecimento em tecnologia.

🚀 Como Usar

Pré-requisitos

• Dart SDK (3.8.0 ou superior)
• Jaspr CLI (instalado globalmente)

Instalação

1. Clone o repositório:

git clone https://github.com/ulisseshen/documentacao.dev.git
cd documentacao.dev

2. Navegue até a pasta src e instale as dependências:

cd src
dart pub get

Desenvolvimento Local

Para iniciar o servidor de desenvolvimento com hot-reload:

cd src
jaspr serve

O site estará disponível em http://localhost:8080

Build para Produção

Para criar uma versão otimizada para produção:

cd src
jaspr build

Os arquivos compilados estarão em src/build/jaspr/

Deploy para Firebase Hosting

Deploy automático configurado via GitHub Actions! 🚀

# Push para a branch main deploya automaticamente
git push origin main

PR Previews: Ao abrir um Pull Request, um deploy de preview é criado automaticamente e o bot comenta no PR com a URL. O comentário é atualizado em cada novo commit (sem duplicatas)!

Veja o Guia de Deploy para instruções completas de configuração.

📁 Estrutura do Projeto

documentacao.dev/
├── src/                    # Aplicação Jaspr
│   ├── content/           # Conteúdo markdown em PT-BR
│   │   ├── _data/         # Configurações (site.yaml, links.yaml)
│   │   ├── index.md       # Página inicial
│   │   ├── instalacao.md  # Guia de instalação
│   │   ├── conceitos.md   # Conceitos básicos
│   │   ├── componentes.md # Guia de componentes
│   │   ├── contribuir.md  # Como contribuir
│   │   └── about.md       # Sobre o projeto
│   ├── lib/               # Código Dart
│   │   ├── components/    # Componentes customizados
│   │   │   ├── donation_buttons.dart
│   │   │   └── clicker.dart
│   │   ├── main.dart      # Aplicação principal
│   │   └── jaspr_options.dart
│   ├── web/               # Assets estáticos
│   │   ├── favicon.ico
│   │   └── images/
│   ├── pubspec.yaml       # Dependências
│   └── analysis_options.yaml
├── .github/
│   └── workflows/
│       └── deploy-firebase.yml  # GitHub Actions para deploy
├── README.md              # Este arquivo
├── DEPLOYMENT.md          # Guia de deploy Firebase
└── LICENSE               # Licença MIT

📝 Adicionando Conteúdo

Para adicionar novas páginas de documentação:

1. Crie um novo arquivo markdown em src/content/:

---
title: Nova Seção
description: Descrição da nova seção
---

# Nova Seção

Conteúdo aqui...

2. Adicione o link na navegação em src/lib/main.dart:

SidebarGroup(title: 'Guias', links: [
  SidebarLink(text: "Nova Seção", href: '/nova-secao'),
]),

💝 Como Apoiar

Este projeto é mantido pela comunidade e depende de doações para:

• ✅ Manter traduções atualizadas
• ✅ Adicionar documentação de novas tecnologias
• ✅ Melhorar a qualidade das traduções existentes
• ✅ Cobrir custos de hospedagem e infraestrutura

Formas de Contribuir

• 💳 PIX: Escaneie o QR Code abaixo para doar

Sua doação ajuda a manter este projeto vivo! 💚

• 🔧 Contribua com código: Envie Pull Requests!
• 📝 Melhore traduções: Ajude a revisar e melhorar
• 🐛 Reporte bugs: Abra issues com sugestões

🤝 Como Contribuir

Contribuições são muito bem-vindas! Veja como você pode ajudar:

🌐 Solicitar Tradução de Documentação

Precisa de uma documentação traduzida? Clique aqui para solicitar uma tradução

💻 Contribuir com Código

1. Faça um Fork do projeto
2. Crie uma branch para sua feature (git checkout -b feature/MinhaFeature)
3. Commit suas mudanças (git commit -m 'Adiciona MinhaFeature')
4. Push para a branch (git push origin feature/MinhaFeature)
5. Abra um Pull Request

Diretrizes

• Use português claro e objetivo
• Siga o guia de estilo existente
• Teste suas alterações em diferentes navegadores
• Mantenha o código limpo e bem documentado

🛠️ Tecnologias Utilizadas

• Dart - Linguagem de programação
• Jaspr - Framework Dart para web (similar ao Flutter)
• Jaspr Content - Sistema de documentação baseado em markdown
• Markdown - Para escrita de conteúdo
• YAML - Para configurações

📄 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

🌍 Comunidade

• GitHub: github.com/ulisseshen/documentacao.dev
• LinkedIn: linkedin.com/in/ulisseshen

🙏 Agradecimentos

Agradecemos a todos os contribuidores que ajudam a manter este projeto vivo e atualizado!

---

Feito com ❤️ pela comunidade brasileira de desenvolvedores