Knockout-Contrib / Knockout-Contrib/Knockout-Validation

Documentation site

Open
#514 1 comment 0 reactions 0 assignees View on GitHub
docs help wanted
Dominant language
JavaScript
Stars
1k
Forks
366
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](http://learn.knockoutjs.com/) - 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

Open the contributing guide

Research direction

Start by reviewing the existing Wiki and the proposal for a gh-pages documentation site. Define the site scope, including interactive tutorials, complete public API documentation, and embedded fiddles for native and custom rules. Done means these documentation areas are available in a navigable site.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.