Start creating documentation

[tpluscode]

Currently the only documentation comes in the readme. The projects needs some more.

@colin-young, do you have any suggestions with regard to human-facing documentation? In last project we created some documentation with mkdocs. It's simple enough written in markdown and has a familiar ReadTheDocs-like theme.

In JsonLd.Entities I went the path of code-as-docs. Each documentation is written in C# and converted into markdown. This way it's easier to keep it in sync with code and also doubles as automatic tests.

GitHub wiki would be ok but does it work in collaboration?

Thoughts?

[colin-young]

I liked the docs in JsonLd.Entities (even if I don't yet fully grok RDF, etc.). I think the wiki is excellent for higher-level documentation, and the mkdocs is excellent for getting into the specific tests and code-level. The nice thing is it's easy to link from the wiki. The wiki is good when you get to wanting to tie together some samples into a theme. e.g. from https://github.com/tpluscode/Nancy.Routing.UriTemplates I might give an overview as you already have, and then add links to the samples where you can provide really detailed information about the specifics of segments and the syntax of defining them.