Better documentation integration (e.g., with algolia)

[philippotto]

Some projects have a very cool and good integration with their documentation. For example, react's doc search is very fast & good (full-text search). If we would integrate something similar into the webKnossos core UI, I'd imagine that users would be more likely to use our documentation. Additionally, we could have logging about what they are searching for (giving us more insights what they need or don't understand).

Screenshot of react's doc search.

React uses algolia which claims to do it for free. However, one would need to apply for it. The terms should work for us, though. See: https://docsearch.algolia.com/docs/who-can-apply/

[hotzenklotz]

We have a pretty good search functionality in our docs: https://docs.webknossos.org. Is this issue still required?

@philippotto Do you want the "better" search functionality in our docs or did you want to integrate search directly into the wK main UI?

[philippotto]

@philippotto Do you want the "better" search functionality in our docs or did you want to integrate search directly into the wK main UI?

My vision was to integrate the search functionality directly into the WK UI. This could be combined with https://github.com/scalableminds/webknossos/issues/5799 so that a user can type into the command palette what s/he is looking for and then either get the right command or get a link to a relevant docs section.

However, as you point out, the docs search is already quite good. So, maybe the benefit of a tighter integration is not that big.