aurelia / validatejs

Enables expressive validation using decorators and/or a fluent API.
MIT License
22 stars 23 forks source link

Start full documentation for the library #42

Closed apawsey closed 8 years ago

apawsey commented 8 years ago

Rather than just updating the readme, we need to start fully documenting the behaviour etc. Is there a template, folder, repository... what's the instructions to start contributing?

(There was a lot of moaning on gitter today, regarding aurelia's docs, so let's start to move it forward)

EisenbergEffect commented 8 years ago

To create documentation, simply start by writing a markdown file. Once that matures, we can convert it quickly into our docs format, drop it in the right location and then publish it to the official docs. We can turn that around pretty quick once the core content is created.

plwalters commented 8 years ago

Plugins are not currently imported in to the docs - is that changing? If not probably makes more sense to start PR'ing the docs folder with standard markdown.

EisenbergEffect commented 8 years ago

We can add plugin docs. We have fetch now. We just need the docs (articles and apis) in the right format.

plwalters commented 8 years ago

👍

jdanyow commented 8 years ago

docs have been added