Kotlin / dokka

API documentation engine for Kotlin

Home Page:https://kotl.in/dokka

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Support non client side search

gpopides opened this issue · comments

Is your feature request related to a problem? Please describe
Not a problem per se but it would improve the searching experience when searching for functions/packages.

Describe the solution you'd like
Currently when i want to search for a method that i don't know if it exists or the precise name i have to go to https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/ and use the client side search:
image

The proposed solution is to support searching using query parameters in the url. For example elixir's documentation supports this:
https://hexdocs.pm/elixir/1.16/search.html?q=member%3F will show all the relative results for member .
image

Rust supports the same. https://doc.rust-lang.org/std/index.html?search=filter.
image

This allows the user to search directly for what he wants without visiting the site and trying to find the link for the docs. On top of that, using the firefox keyword bookmark this allows searching using something like <keyword> isEmpty

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered

Additional context