Hey I am lead dev on the popular open source library Library kotlinlang #getting-started

Hey I am lead dev on the popular open source libra...

# getting-started

i

igor.wojda

09/26/2023, 11:11 PM

Hey I am lead dev on the popular open source library. Library is provided with documentation artifacts, so IDE currently display desc of all methods, properties etc. However I am thinking about putting KDocs generated by Dokka online (automatically with every release). Is there good place you would recommend to host this type of open-source documentation?

j

Jeff Lockhart

09/26/2023, 11:17 PM

Is your library hosted on GitHub? You can use GitHub Pages.

☝️ 2

v

Vampire

09/27/2023, 6:53 AM

You could try to make

<http://javadoc.io|javadoc.io>

support KDocs

👍 1

h

hfhbd

09/27/2023, 7:18 AM

If you use dokka, you can add links to the docs of your used libs: https://kotlinlang.org/docs/dokka-gradle.html#external-documentation-links-configuration

j

Johann Pardanaud

09/27/2023, 7:39 AM

I'm using GitHub Pages for my library Akkurate : https://akkurate.dev/api/ This is done with a workflow here: https://github.com/nesk/akkurate/blob/b0eeea4/.github/workflows/deploy-website.yml#L67-L95 and there: https://github.com/nesk/akkurate/blob/b0eeea4/.github/workflows/deploy-website.yml#L133-L155 I really recommend you this, it works fine!

👍 1

c

CLOVIS

09/27/2023, 8:11 AM

Since other people mentioned GitHub Pages, here's the setup for GitLab Pages 🙂 https://gitlab.com/opensavvy/pedestal/-/blob/main/.gitlab-ci.yml?ref_type=heads#L197-232 (if you have any questions, feel free to ask)

👍 1