Knockout-Contrib/Knockout-Validation

Documentation site

Open

#514 opened on Jan 21, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (1,024 stars) (394 forks)batch import
docshelp wanted

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.

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic web developmentKnockout Validation knowledgeHTML/CSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.