Documentation page

[mulderp]

Hi,

to understand what/how this project can be documented, what do you think of the Backbone.js docs, or its derivatives (Underscore, Bookshelf, e.g. http://bookshelfjs.org/ ) The advantage, it can be used as references as well as an overview reading.

The main topics topics might be:

• Introduction
• Models/Collection
• Changelog
• FAQ

I might work on this if you are interested.

[kosmikko]

Hi,

Thanks for the initiative! Yeah I think Backbone.js style docs (or something similar) would be great. And any help would be greatly appreciated, since I don't think we can focus very much on the docs yet. I will surely help if you get things started.

[mulderp]

I will work on this in between my other jobs too, but I will explore the work here: https://github.com/mulderp/serverbone/tree/docs (added a first index.html as start)

I notice there is some github page configuration in Underscorejs, Bookshelf, etc. which works with a CNAME. I also add that domain serverbonejs.org - although not sure if this will work like so out of the box.

As place to start documenting, I think I will at the various Collection types first - update later.

[Nomon]

I registered http://serverbonejs.org/ pointed it to Everyplay/serverbone#gh-pages branch and merged your index.html from your docs branch into there.

[mulderp]

Thanks! I just cleaned up some of the rough edges... more to come, but the updated one should look slightly better.

[mulderp]

I close this one for now.