Missing Search API search engine Documentation

[serkef]

Is your feature request related to a problem? Please describe.
One of the options when setting up a search engine is a custom Search API (see pic below). Unfortunately, there is no documentation on how to use it. Especially it is not defined how the mapping should work. It says:

This Javascript is run in the browser to map custom search api responses to what Quepid understands.

But I found nowhere in the documentation an explanation. Is it a mapping to Solr responses? Or Open search? Or Elastic? A clear schema definition would massively help.

Describe the solution you'd like
A description and an example of what the javascript mapping should return would be very helpful.

Describe alternatives you've considered
I've searched and found a blog post and a couple of related PRs [1,2], but none of them addresses the problem.

Additional context
Only 2 of the 6 Search Engine options are documented. Maybe it's something that is obvious and I'm missing.

[epugh]

I really appreciate your calling this out! It's exciting that the fact that you noticed that docs are missing means folks are interested!

So yeah..... In true open source pattern, we moved faster on writing the code then we did on writing the docs/tutorials to support the code.

So, we have two things to get better docs, we need some folks to volunteer to do the docs, and then the repo that hosts the docs, quepid-web which is currently a private repo needs to be made public so folks can contribute.. And then, with that, we need to rewrite the https://quepid.com/tutorials/#quepid-for-human-raters section to reflect the use of books!