Odi-ts/odi

Create docs for all framework parts

DanTsk opened this issue · 7 comments

Create docs for all framework parts

Hello! I'm happy to create the docs if you can guide me a little. I'm comfortable with Node and familiar with TypeScript, so it shouldn't be a huge problem. 😃

Maybe TypeDoc for autogenerating some of the docs.

@ankush981 That will be really awesome! Let Christmas holidays pass and we can discuss everything in gitter !

@JWinnie Great idea! I think it will be good for the Reference docs, but don't know about Gitbook docs. I want to have the maximum of readability, so developers can easily jump in and start hacking!
But anyway, we can try!

TypeDoc is cool, but my idea is to write more descriptive, beginner-friendly guides. The best example I can provide is https://docs.djangoproject.com/ 🙂

@DanTsk Cool! What's the Gitter community name?