search

MyFormworks / Formworks

Formworks is a framework for building forms from JSON files.
https://myformworks.github.io/Formworks/
MIT License
6 stars 1 forks source link

Use Jazzy as a Action to create code documentation #14

Closed EdgSgroi closed 3 years ago

EdgSgroi commented 4 years ago

The Jazzy framework, presented by Babo, is a great solution to document code in a quick way during the development while this documentations is automatically released in a static HTML page. Also is a good opportunity to learn how to make a single and consistent documentation.

Jazzy repo: https://github.com/realm/jazzy

This issue can only be resolved with the help of the following issue in SwiftPM Jazzy Docs: https://github.com/sersoft-gmbh/swifty-docs-action/issues/1

csfar commented 4 years ago

Eu adicionei a label de dev-task mas acho que não faz sentido. Pensei em criar uma chama de repo, para coisas como arrumar o CI, adicionar SwiftLint e o Jazzy. O que você acha?

csfar commented 4 years ago

Eu acho o uso do Jazzy algo legal. Podemos ter dois tipos de documentação: o Jazzy, para o código, e os docs em site estático, para tutoriais e etc.

Galdineris commented 4 years ago

Jazzy is still not updating the documentation and needs maintenance.