odi icon indicating copy to clipboard operation
odi copied to clipboard

Create docs for all framework parts

Open DanTsk opened this issue 6 years ago • 7 comments

DanTsk avatar Oct 19 '18 14:10 DanTsk

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. :smiley:

ankush981 avatar Dec 28 '18 14:12 ankush981

Maybe TypeDoc for autogenerating some of the docs.

jepotter1-archive avatar Dec 29 '18 19:12 jepotter1-archive

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

DanTsk avatar Dec 29 '18 20:12 DanTsk

@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!

DanTsk avatar Dec 29 '18 20:12 DanTsk

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/ :slightly_smiling_face:

ankush981 avatar Dec 30 '18 15:12 ankush981

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

ankush981 avatar Dec 30 '18 15:12 ankush981

@ankush981 https://gitter.im/odiland/community

DanTsk avatar Jan 02 '19 15:01 DanTsk