Knockout-Contrib/Knockout-Validation

Documentation site

Open

#514 ouverte le 21 janv. 2015

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)JavaScript (394 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (1 024 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Configurez un site GitHub Pages pour le projet, créez des tutoriels interactifs similaires au site d'apprentissage de KnockoutJS et documentez toutes les méthodes d'API publiques. Utilisez un générateur de site statique comme Jekyll ou un outil basé sur JavaScript. Incluez des fiddles intégrés pour les règles.
Stack technique
javascript
Domaine
documentationfrontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitHTMLCSS
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70