Publish API documentation

[deepy]

We should probably generate javadoc for the tasks and publish it on github pages or somewhere.

[deepy]

So. We can generate Javadoc with dokka, but only if we use JDK 8.
There's an open issue from 2018 regarding this Kotlin/dokka#294 and there's a fix promised for the next version.

And if we were on bintray or maven central we could've used javadoc.io for hosting the documentation automatically

[deepy]

It's missing information but that's easily added later on: https://node-gradle.github.io/gradle-node-plugin/

[IgnatBeresnev]

Hi! Accidentally came across this. Is there a reason you're building javadoc and not dokka's own html format?

javadoc format is in alpha at the moment and has many bugs. We focus on making html stable and sometimes throw in nice features :)

[deepy]

Hi @IgnatBeresnev

It's actually even worse, we're using an old vintage version of dokka to get as proper javadocs as we can 😅
(see Kotlin/dokka#1692)

But the short answer is that personally I really really like javadocs, they work great with tools like dash/zeal, IDEs, and there's a pretty big ecosystem around javadocs.

And with good Javadocs you can get a lot of documentation with little effort!
(I say this knowing full well that our Javadoc is pretty bad, but I intend to fix that, I just need to find the time for it 🥲)

And as for HTML, it looks a bit minimalistic in 0.10.0 but I just gave it a quick try again

[IgnatBeresnev]

I see :) Here's how the new HTML format looks like btw: https://kotlin.github.io/kotlinx.coroutines/