Knockout-Contrib/Knockout-Validation

Documentation site

Open

#514 geöffnet am 21. Jan. 2015

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (394 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (1.024 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Richten Sie eine GitHub Pages Website für das Projekt ein, erstellen Sie interaktive Tutorials ähnlich der KnockoutJS Lernseite und dokumentieren Sie alle öffentlichen API Methoden. Verwenden Sie einen statischen Site Generator wie Jekyll oder ein JavaScript basiertes Tool. Fügen Sie eingebettete Fiddles für Regeln hinzu.
Tech Stack
javascript
Domain
documentationfrontend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
GitHTMLCSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70