Atualmente a documentação do projeto está distribuída entre o código e o Wiki, o que gera duplicação de informações e risco de desatualização.
A proposta é gerar o manual em HTML a partir da fonte oficial (LaTeX) e publicá-lo no site do projeto, substituindo o uso do Wiki.
O manual pode ser gerado com:
cd doc/manual
latex2html manual.tex
Sempre que uma nova release for gerada, o site/manual deve ser republicado automaticamente, garantindo que a documentação esteja sempre alinhada com a versão mais recente do projeto.
Referência:
https://github.com/gportugol/gpt/blob/master/HACKING.md#documenta%C3%A7%C3%A3o
Benefícios
- Evita múltiplos pontos com a mesma informação
- Documentação sempre atualizada
- Fonte única de verdade para o manual
Atualmente a documentação do projeto está distribuída entre o código e o Wiki, o que gera duplicação de informações e risco de desatualização.
A proposta é gerar o manual em HTML a partir da fonte oficial (LaTeX) e publicá-lo no site do projeto, substituindo o uso do Wiki.
O manual pode ser gerado com:
Sempre que uma nova release for gerada, o site/manual deve ser republicado automaticamente, garantindo que a documentação esteja sempre alinhada com a versão mais recente do projeto.
Referência:
https://github.com/gportugol/gpt/blob/master/HACKING.md#documenta%C3%A7%C3%A3o
Benefícios