ayrtonteshima/ead-api

Site para documentação

Opened this issue · 6 comments

ribafs commented

Olá a todos!

Gostaria de colaborar com a criação de um site para a documentação aqui mesmo neste repositório. Pode ser feito facilmente na pasta docs.

Pesquisei bastante sobre estes geradores de sites estáticos que podem ser hospedados no GitHub. O que mais gostei foi do mkdocs, mas se alguém conhecer outro que seja melhor vamos trocar ideia.
https://www.mkdocs.org/

Ele trabalha com markdown e gera em HTML.

ribafs commented

Com o intuito de melhorar um debate...
Estudando o material que tenho sobre o MkDocs acabei criando um repositório para mostrar como fica um site estático criado com ele. Apenas um teste não acabado. Em especial veja a seção PHP e o tutorial.
https://ribafs.github.io/mkdocs/

orodrigogo commented

Com o intuito de melhorar um debate...
Estudando o material que tenho sobre o MkDocs acabei criando um repositório para mostrar como fica um site estático criado com ele. Apenas um teste não acabado. Em especial veja a seção PHP e o tutorial.
https://ribafs.github.io/mkdocs/

Interessante essa ferramenta ein. Uma boa ideia ir documentando o projeto.
Não rola usar a Wiki do próprio Github aqui?

  • 👍1
Deleted user commented

Boa pessoal!
Vou caçar mais alguns também para olharmos.
Gostaria de fazer um site também para promover a plataforma, ter a documentação e futuramente até uma área de blog

  • 👍2
nelsonmfinda commented

Acho uma boa ideia @ribafs

ribafs commented
Deleted user commented

Aqui tem uma boa relação de tools para documentar API: https://nordicapis.com/ultimate-guide-to-30-api-documentation-solutions/

Estou pensando, depois que adotarmos uma e começar a documentar, vou hospedar em algum lugar (google cloud, aws, digital ocean...) e todo commit no master, vai fazer o deploy automático de toda aplicação (containers) e podemos ficar brincando com a API :)

  • 👍2