Hey folks! :kotlin-intensifies: As you may noticed the current design strategy of Dokka is to make i...

# dokka

[Eugene]

Hey folks! K
As you may noticed the current design strategy of Dokka is to make it pluggable. In other words we want to make it extendable with ease.
In this round of feedback I'd like to message/talk to people who have something to say about existed API:
• How does it convenient?
• What about examples and docs?
• Any suggestions to improve
• etc
This is the most critical topic right now and hope you have something to share.

Please leave ➕ and I'll message you to ask some questions. Thanks in advance)

[audriusk]

What I would like to see is unified API ref doc generation for ALL KT mutiplatform packages.

Please take example from:
- Flutter. Every packages on https://pub.dev have unified API docs. It's possible to get docs for every version of a package.
- Rust docs. Ideal example. https://docs.rs Every packages has docs.
- Possible to generate docs offline for every package without mercy of package developer (if she applied some plugin to her project or not).
- All docs have same style
- Very good built-in offline search
- Colored text for different types. This brings same benefit as code high-lighting. That improves readability after getting used to color's meaning .
- Local settings for individual user preferences
- Easy navigation to source code

Please don't make an easy way to customize themes for individual packages. Or there will be people who will decide that they can make better themes...

Don't make html docs theme which look like marketing page with "nice" design. Make theme which is practical. I am using browser with vim plugin (keyboard only navigation). That sliding navigation from right side is unusable for me. And whole current dokka theme has huge padding which might look better for someone but decreases usability and forces to scroll more.

[audriusk]

... What is this navigation?? :D

[Eugene]

Thanks for sharing!
Could you elaborate this point? I think I don't understand it.

- Possible to generate docs offline for every package without mercy of package developer (if she applied some plugin to her project or not).

[audriusk]

Rust package manager Cargo has command doc which can generates documentation for project itself and all project's dependencies.

[mikehearn]

If the source code is available there is no actual requirement for the upstream developer to generate docs themselves. It could be done also by users.