Documentation for 0.3.0 release

[SphtKr]

The API has changed pretty substantially in some places and even the old version wasn't well documented. Lumping everything on the front page is probably not going to cut it this time.

• Use wiki? Github Pages?
• Migration guide? Do we have enough users yet? NuGet says we've had 222 and 179 download of JSONAPI and JSONAPI.EntityFramework respectively.
• I like using in-code comments but sandcastle is a pain and I don't think MyGet supports it. Is there something else to auto-generate API docs that I'm unaware of?

[csantero]

Use wiki? Github Pages?

We should use Github release notes for documenting the changes in the release. I like how Ember CLI does it. We're going to want better organized general documentation soon too. Wiki is probably easier to set up than a nice-looking gh-pages site.

Migration guide?

I think a bulleted list of changes with an indication as to the type of change (Bugfix, Feature, Breaking, etc.) is enough.

I like using in-code comments but sandcastle is a pain and I don't think MyGet supports it. Is there something else to auto-generate API docs that I'm unaware of?

Yeah this would be handy, I don't really have any suggestions though.

[SphtKr]

Okay, I did the SHFB thing...it wasn't quite as bad as I remembered. I set up GitHub pages specifically for hosting the SHFB generated docs and...it works:

• http://sphtkr.github.io/JSONAPI.NET/doc/JSONAPI/
• http://sphtkr.github.io/JSONAPI.NET/doc/JSONAPI.EntityFramework/

Now there's just the trivial thing of going back and actually adding all those code comments.

[SphtKr]

And, yeah, looks like the Wiki is going to be the way to go for general docs, I've stared the Migration Guide.

[csantero]

Neat!