hugapi/hug

hug needs more documentation

Open

#319 aperta il 25 mag 2016

Vedi su GitHub
 (10 commenti) (8 reazioni) (0 assegnatari)Python (389 fork)batch import
bugenhancementhelp wanted

Metriche repository

Star
 (6758 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

hug has a collection of documentations on hug.rest and on the github repo (including examples etc) which has served as a reasonable starting point. However, for continued growth, a wider depth of and a higher quality of documentation is an absolute necessity and it is the number 1 priority for the project.

Feel free to add any ideas for additional documentation sources that could be useful for the project to this issue. The currently known ones are:

  • FAQ
  • Known Issues / Gotchas
  • Best Practices
  • Example starting points
  • Full documentation for all exposed APIs and features

I, and the entire community, would be grateful for any help in this area.

Thanks!

~Timothy

Guida contributor

Direzione di ricerca
Contribuisci alla documentazione aggiungendo FAQ, best practice o punti di partenza di esempio per il framework API hug.
Tech stack
python
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90