arcostasi / docs-franzininho-site

Documentação do pojeto Franzininho

Documentação do projeto Franzininho

Documentação feita com Docusaurus 2.

Aqui concentramos toda a documentação para os primeiros passos com placas e projetos Franzininho

Contribuição

Você pode contribuir com a documentação da seguinte forma:

• Correção dos materiais já publicados;
• Escrita de novos tópicos

Para isso faça os seguintes passos:

1. Crie uma Issue sobre a problema ou implementação;
2. Faça Fork do projeto
3. Crie uma nova branch: git checkout -b nova-branch
4. Commit suas mudanças: git commit -m 'Adicionei nome-do-projeto'
5. Push para a branch: git push origin nova-branch
6. Abra um Pull Request
7. Após a revisão e aprovação pelo time de documentação será feito o deploy
8. Depois que o seu PR for unido ao projeto, você pode deletar a sua branch.

Usando o docusaurus

Você precisará instalar no seu computador:

• Node.js versão >= 10.15.1
• Yarn versão >= 1.5

Após o fork, entre na pasta do projeto:

• Instale

yarn install

• Teste localmente

yarn start

Este comando inicia um servidor de desenvolvimento local e abre uma janela do navegador. A maioria das alterações são refletidas ao vivo, sem a necessidade de reiniciar o servidor.

Para mais detalhes acesse a documentação do Docusaurus V2