Knockout-Contrib/Knockout-Validation

Documentation site

Open

#514 aperta il 21 gen 2015

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)JavaScript (394 fork)batch import
docshelp wanted

Metriche repository

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

Descrizione

I was thinking on creating a gh-pages branch and have a site for this library. Currently the documentation is in the Wiki and I find it pretty hard to navigate and identify the relevant information.

The key aspects that should be covered are:

  • provide newcomers a bunch of interactive tutorials (similar to how KnockoutJS has - not necessarly the same!)
  • provide full API documentation - every method that's public should be documented
  • provide some embeded fiddles for native and custom rules

...and more.

If anyone is willing to work on this it will be great.

Guida contributor

Direzione di ricerca
Configura un sito GitHub Pages per il progetto, crea tutorial interattivi simili al sito di apprendimento di KnockoutJS e documenta tutti i metodi dell'API pubblica. Utilizza un generatore di siti statici come Jekyll o uno strumento basato su JavaScript. Includi fiddle incorporati per le regole.
Tech stack
javascript
Dominio
documentationfrontend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GitHTMLCSS
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70