motorcyclejs / motorcycle

Open discussions for features/issues unrelated or general to current libraries.
15 stars 1 forks source link

Create comprehension documentation for all libraries #22

Closed TylorS closed 7 years ago

TylorS commented 8 years ago

Overview

Use something like documentation.js to create nice API docs for all of the libraries

Motivations

Poor documentation is the bane of many open-source projects. Motorcycle is really no exception at the moment. Using something like documentation nice, organized documentation is very achievable and maintainable.

Example

https://tylors.github.io/cyclic-router/docs

Progress