Just wondering if anyone has a suggestion for a Jazzy type documentation generator in Android land

# announcements

[Venaseph]

Just wondering if anyone has a suggestion for a Jazzy type documentation generator in Android land

[ribesg]

You’re asking for a documentation tool on the Kotlin Slack, so the answer you’ll get would be https://github.com/Kotlin/dokka

[ribesg]

I don’t know anything better for Kotlin code, yet

[Venaseph]

Thanks, that's a step towards a place to start spleunking

[Casey Brooks]

Orchid is a more fully functional website generator that integrates with Dokka under-the-hood. Here’s a good tutorial for getting started using it for Kotlin documentation https://dev.to/cjbrooks12/how-to-document-a-kotlin-project-edc

Full disclosure, I am the developer of Orchid https://orchid.netlify.com/

[ribesg]

@Casey Brooks I spent 5 minutes looking for an example and didn’t find any, which is a problem

[Casey Brooks]

The “How To Document A Kotlin Project” is the example, and right at the beginning of it there’s a link to the OrchidTutorials project which has the full source of that tutorial. https://github.com/JavaEden/OrchidTutorials. The homepage also has the following snippet as a quickstart

git clone <https://github.com/JavaEden/OrchidStarter.git>
cd OrchidStarter
./gradlew orchidServe

# View your generated site at <http://localhost:8080/>

https://github.com/JavaEden/OrchidStarter is another example project

[ribesg]

I’m not saying “how to use” example, I’m looking for example result

[Casey Brooks]

https://orchid.netlify.com/ is also an example result, the entire site and its API docs are are built using itself https://orchid.netlify.com/com/eden/orchid. https://strikt.io/ (#CAR7KJ96J) and https://pebbletemplates.io/ are also sites built with Orchid, along with a few others which are linked to in the project’s README https://github.com/JavaEden/Orchid#example-orchid-sites

[ribesg]

An example of what the “Javadoc-like” part of such project looks like should be like the first link at the top of the site or the Readme

[ribesg]

I wasn’t patient enough to scroll all the way down there to find it, and I won’t be the only one 🙂 Looks cool though

[Casey Brooks]

I completely agree. I’m currently working on a major overhaul of the docs to put the “javadoc-like” features front-and-center and really focus on that idea. Thanks for the feedback!