Como Contribuir com a Documentação¶

Este guia descreve o fluxo para criar ou atualizar documentos nesta base de conhecimento.

🔄 Fluxo de Trabalho Recomendado¶

Para manter a documentação organizada e sem quebras de layout ou links mortos, recomendamos o seguinte fluxo:

graph LR
    A[Clonar Repositório] --> B[Criar Branch]
    B --> C[Editar / Gerar com LLM]
    C --> D[Abrir Pull Request]
    D --> E[Preview Automático no Firebase]
    E --> F[Revisão e Merge no main]
    F --> G[Deploy Automático em Produção]

1. Baixar o Repositório (Git Clone)¶

Se ainda não tem o repositório localmente, clone-o através do Git:

git clone https://github.com/f4bioss/gestao-conhecimento.git
cd gestao-conhecimento

2. Criar uma Branch¶

Nunca envie alterações diretamente na branch main quando trabalhar em equipe ou para alterações maiores:

git checkout -b docs/meu-novo-artigo

3. Adicionar seu Documento¶

Você pode escrever o documento manualmente ou delegar todo o processo para uma LLM / Agente de IA:

Opção A (Manual): Crie o arquivo .md dentro da pasta docs/ apropriada e adicione ao menu nav: em mkdocs.yml.
Opção B (Recomendada - Via LLM): Utilize um agente de IA (Antigravity, Claude Code, Gemini CLI, Cursor) fornecendo apenas o tema ou anotações brutas. O agente se encarrega de criar o arquivo, formatar no padrão MkDocs, registrar no menu e abrir o PR. 👉 Consulte o Guia do Usuário: Produção com LLMs para ver prompts prontos.

4. Testar Localmente (Opcional)¶

Você pode rodar o servidor local para ver as alterações em tempo real:

mkdocs serve

Acesse no navegador: http://127.0.0.1:8000.

5. Abrir um Pull Request (PR)¶

Ao subir a branch para o GitHub e abrir um Pull Request: - O GitHub Actions dispara automaticamente um canal temporário de Preview no Firebase Hosting. - Um link com o site compilado é comentado diretamente no seu PR para validação.

6. Merge para Produção¶

Ao mesclar o Pull Request na branch main, a Action publica imediatamente a versão definitiva no canal de produção (live) do Firebase.