Guia para Colaboração na Documentação

Olá! Este é um guia passo a passo para ajudá-lo a colaborar na documentação do projeto usando o MKDocs. Vamos abordar os conceitos básicos e passar por todas as etapas necessárias para colaborar com sucesso na documentação do projeto.

Pré-requisitos

Instalar o Git
Instalar o Python
Instalar o Visual Studio Code (ou outro editor de texto de sua preferência)

Configuração Inicial

Clone o repositório da documentação:

git clone https://github.com/prefeiturasp/SME-PTRF-Docs.git docs

Navegue até a pasta do repositório clonado:
```
cd docs
```

Instale as dependências do projeto:

# Linux ou MacOS: 
pip install -r requirements.txt

Windows:

# Windows:
py -m pip install -r requirements.txt

Editando a Documentação

Abra o Visual Studio Code (ou outro editor de texto) e navegue até a pasta do repositório.
Encontre o arquivo que deseja editar e faça as alterações necessárias.
Salve o arquivo quando terminar.

Visualizando suas Alterações Localmente

Abra o terminal e navegue até a pasta do repositório.

Execute o seguinte comando:

# Linux ou MacOS:
mkdocs serve

# Windows:
py -m mkdocs serve

Abra seu navegador e acesse http://127.0.0.1:8000 para visualizar suas alterações.

Enviando suas Alterações

Abra o terminal e navegue até a pasta do repositório.
Verifique se há alterações no repositório remoto:
```
git pull
```
Adicione as alterações ao Git:
```
git add .
```
Faça um commit das alterações:
```
git commit -m "Mensagem descritiva das alterações"
```
5. Envie as alterações para o repositório remoto:
```
git push
```

ATENÇÃO!

Sempre certifique-se que o seu repositório local está atualizado com as últimas alterações do repositório remoto antes de iniciar suas alterações. Para isso, execute o comando git pull antes de começar suas mudanças.

Usando o VSCode para enviar suas mudanças

O Visual Studio Code possui recursos nativos para trabalhar com o Git, facilitando a execução de comandos como git add, git commit e git push. Veja como realizar essas ações usando a interface do Visual Studio Code:

Git Pull

Abra a aba "Controle do Código-Fonte" no painel lateral esquerdo do Visual Studio Code (ícone de um círculo com uma ramificação).
Clique nos três pontos (⋯) no canto superior direito da aba "Controle do Código-Fonte" e selecione "Pull" no menu suspenso. Isso é equivalente a executar o comando git pull.
Isso atualizará seu repositório local com as alterações mais recentes do repositório remoto.

ATENÇÃO!

Sempre certifique-se que o seu repositório local está atualizado com as últimas alterações do repositório remoto antes de iniciar suas alterações. Para isso, execute o comando git pull antes de começar suas mudanças.

Git Add

Abra a aba "Controle do Código-Fonte" no painel lateral esquerdo do Visual Studio Code (ícone de um círculo com uma ramificação).
Você verá uma lista de arquivos modificados. Cada arquivo terá um símbolo "+" ao lado.
Clique no símbolo "+" ao lado de cada arquivo que deseja adicionar ao Git. Isso é equivalente a executar o comando git add.

Git Commit

Depois de adicionar os arquivos desejados, digite uma mensagem de commit na caixa de texto no topo da aba "Source Control".
Clique no ícone de "check" (✓) acima da caixa de texto ou pressione Ctrl+Enter (ou Cmd+Enter no macOS) para confirmar o commit. Isso é equivalente a executar o comando git commit.

Git Push

Após realizar o commit, clique nos três pontos (⋯) no canto superior direito da aba "Source Control".
No menu que aparece, selecione "enviar por Push" para enviar suas alterações para o repositório remoto. Isso é equivalente a executar o comando git push.

Utilizando o recurso nativo do Visual Studio Code para trabalhar com o Git, você pode se concentrar na documentação sem precisar lidar com a linha de comando.

Dicas Adicionais

Use o recurso de pesquisa na aba de extensões do Visual Studio Code para encontrar outros plugins úteis que podem ajudá-lo a trabalhar de forma mais eficiente com Git e GitHub.
Personalize o Visual Studio Code de acordo com suas preferências, instalando temas e outros plugins que melhorem sua produtividade.

Se tiver dúvidas peça ajuda

Se você tiver alguma dúvida ou encontrar problemas, entre em contato com a equipe de desenvolvimento para obter ajuda.