kshitij10496/hercules

Generate API documentation

Aperta

#45 aperta il 8 nov 2018

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Go (18 fork)auto 404
discussiondocumentationenhancementhelp wanted

Metriche repository

Star
 (35 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We need to find a way to generate the API documentation.

Options:

Suggestions welcome!

Guida contributor

Direzione di ricerca
Valuta lo strumento suggerito 'summerfish swagger' e altri per generare documentazione API dal codice Go. Considera l'integrazione con la struttura del progetto esistente.
Tech stack
go
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60