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 (1.024 Stars) (394 Forks)batch import
docshelp wanted

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

Tech Stack
javascript
Domain
documentation
Issue Type
feature
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 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Basic web developmentKnockout Validation knowledgeHTML/CSS
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
To implement this documentation site, begin by examining the existing Wiki content at https://github.com/Knockout Contrib/Knockout Validation/wiki to understand the current documentation. Then, set up a GitHub Pages site using a static site generator like Jekyll or a plain HTML/CSS structure. Focus on creating interactive tutorials similar to KnockoutJS's learn.knockoutjs.com and provide full API documentation by extracting method signatures from the source code. Ensure the site includes embedded JSFiddle examples for native and custom rules.