Versionamento do código desenvolvido no GitHub

[DaianeAlvesRJ]

Perguntas

• Utilizaremos alguma ferramenta para geração de documentação?

Entregáveis

• Repositório criado
• Definição de licenças iniciais e uso de SPDX por arquivo
• Configurar DCO e bot para aplicar DCO

[henmohr]

Opções para gerar documentação:

• Github Wiki
• Github Pages
• Jigsaw
• Doctave
• Docs by Hashnode
• GitBook
• Mintlify
• Netlify
• Read The Docs
• https://github.com/BookStackApp/BookStack

[vitormattos]

Documentação do Jigsaw:
https://jigsaw.tighten.com/

Código fonte do site do Jigsaw:
https://github.com/tighten/jigsaw-site

Uma possibilidade é copiar o site do jigsaw e alterar o conteúdo.

Ponto positivo:
Site da LibreCode e do LibreSign já são em Jigsaw, a @Any97Cris tem já boas habilidades com ele e é em PHP, qualquer coisa fica simples para fazermos qualquer tipo de integração ou automação no site até mesmo copiando ideias do site da LibreCode e do LibreSign.

Observação: Talvez seja uma boa um repo para documentação e outro repo para código, mais para facilitar/simplificar processo de build e montagem de ambientes e isolar escopos do que são dependências do site e dependências do projeto.

[henmohr]

Material para MkDocs para ser ótimo. Tem funcionalidades de busca avançada e pode funcionar offline, além de outras funcionalidades.

• https://squidfunk.github.io/mkdocs-material/#more-than-just-a-static-site

[vitormattos]

• https://github.com/LibreSign/libresign/blob/main/.github/workflows/block-unconventional-commits.yml
• https://github.com/LibreSign/libresign/blob/main/.github/workflows/reuse.yml