j2labs / brubeck

Asynchronous web and messaging
http://brubeck.io
511 stars 66 forks source link

Brubeck documentation #108

Open kracekumar opened 11 years ago

kracekumar commented 11 years ago

Currently we have very little documentation, as we discussed in Google Hangout, we should add docs for using third party python libraries.

We have brubeck.io as a separate repo with html pages and we do have docs directory with md files. @j2labs if I am right, brubeck.io uses brubeck.io repo with html. If so we are duplicating work. Can we make brubeck.io use github hook whenever a change is pushed to master branch brubeck.io converts all md to html and serves like static generator ?

Whenever new feature is added can we make it as the rule that the contributor is supposed to add supporting doc for the feature without that pull request isn't accepted ?