Knockout-Contrib/Knockout-Validation

Documentation site

Open

#514 opened on Jan 21, 2015

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

Repository metrics

Stars
 (1,024 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Set up a GitHub Pages site for the project, create interactive tutorials similar to KnockoutJS's learn site, and document all public API methods. Use a static site generator like Jekyll or a JavaScript based tool. Include embedded fiddles for rules.
Tech stack
javascript
Domain
documentationfrontend
Issue type
Documentation
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
GitHTMLCSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70