Document code

[ericholiveira]

We must document studio code and use some lib to generate documentation from it. Any ideas on the lib?

[avishnyak]

I tend to use DocStrap (a JSDoc3-based doc generator) because it's easy to get running, everyone understands JSDoc, is themeable, has search built in and has the ability to add markdown tutorials right to the final output.

Here is an example including tutorials:
http://docstrap.github.io/docstrap/themes/flatly/index.html

[sean-hill]

@ericholiveira I really like gitbook. It's really sexy and simple to use. Check out featherjs as an example. It's also easy to use with Github, so that's a plus 👍

[sean-hill]

@ericholiveira we could also create a Studio github organization because it sounds like we'll have multiple repositories, and it'd be helpful to not have them all under your own github account, and have us all as members instead.

[sean-hill]

@ericholiveira as an example I threw this together really quick.

Gitbook example

[ericholiveira]

@sean-hill i completely agree with a Studio organization, thats the reason ive been asking you guys about your vision on the future of the project to make sure we are all on the same page. Also, i loved this gitbook, its possible to generate api documentation from codes comments like jsdoc? If its not possible, can we integrate both (jsdoc and gitbook)?

[avishnyak]

@ericholiveira we can probably make jsdoc to gitbook happen by using jsdoc-to-markdown as part of the build steps.

Also, here is an example of what looks like gitbook documentation that is similar to Studio.

https://www.serfdom.io/docs/index.html