kalix-jvm-sdk icon indicating copy to clipboard operation
kalix-jvm-sdk copied to clipboard

Javadocs are slightly broken, should we just drop them?

Open ennru opened this issue 1 year ago • 2 comments

Our docs build is quite involved and does even merge the Javadoc from multiple modules in a brute-force way:

https://github.com/lightbend/kalix-jvm-sdk/blob/e40a450fe36ca668a12b25866042ae1a9c415421/docs/Makefile#L71-L74

The index files will not be correct.

We have very few links in that point to the Javadoc and I doubt those are too useful. IDEs normally download the Javadocs for libraries so there users get help.

I suggest we simply don't put the Javadoc onto docs.kalix.io

Refs

  • https://github.com/lightbend/kalix-docs/issues/1891

ennru avatar Aug 30 '23 16:08 ennru

If we're not using it much, then could remove. Otherwise unidoc to properly combine.

pvlugter avatar Aug 30 '23 22:08 pvlugter

I looked at introducing unidoc, but the build is too special to do that easily.

ennru avatar Oct 23 '23 13:10 ennru