metosin/compojure-api

New documentation site

Open

#329 aperta il 28 lug 2017

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Clojure (149 fork)batch import
enhancementhelp wanted

Metriche repository

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

Descrizione

new separate site with new docs for 2.0.0, to replace the current wiki.

  • meta(was: #312)
  • deployment (was: #188)
  • nil body handling (was: #251)
  • no-AOT-docs (was: #155)

Guida contributor

Direzione di ricerca
Rivedi le issue referenziate (#312, #188, #251, #155) per comprendere i requisiti della documentazione. Esplora il contenuto wiki esistente e la struttura della documentazione del repository. Decidi un generatore di siti statici (ad esempio Jekyll, Hugo o uno strumento basato su Clojure come Cryogen) e pianifica la gerarchia dei contenuti. Quindi implementa il nuovo sito e aggiorna i collegamenti.
Tech stack
clojure
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70