Search on docs site: Do you use it? Does it work for you?

Hi all!

Recently we upgraded the docs site to the latest version of Hextra, which has enabled some great new features (This is different from the recently added Kapa AI tool). My question to the community is how is search working for you? Do you use it often? Is it effective?

One of the changes that the new version of Hextra brought is a refined search experience. You can see difference in this video of current site (top) vs and older copy (bottom) which illustrates some of the differences:

Upon further investigation, we found:

it gives answers to more detailed prompts: for example, if you search for Testing Forms, Testing the CHT, or Testing Contact Summary, or other similar prompts, you would get results.

Please let us know what you think!

My initial reaction is that the new search is better. It gets me where I want to go without a lot of extra scrolling!

3 Likes

Okay, new complaint… :sweat_smile: I literally cannot get it to give me any results for permissions (even though we have a whole page for it. I can get some results if I search for user permissions but nothing for just permissions… :thinking:

Ah - interesting! This mirrors my results for testing . I think it will never return results for a single search term maybe? Maybe we could say “Search requires at least two search terms” or something?

@andra - do you know if there’s configuration options could tweak?

I tried to change the tokenize parameter of the flexsearch to full in this PR, and the search returns slightly more results (for example, if ones searches for Permissions, it returns 2 results instead of 0).

The complexity of the full option is higher, but I don’t see a visible performance degradation.

It would be helpful to test the branch in the PR locally and assess if the search results return the options you were expecting.

Thanks @jkuester and @andra for the prompt research in into improving search! The PR you mentioned is now live and I see single words are returning results on the docs site.

Anybody reading this - please drop a note here and let us know what you think of search!

1 Like

:thinking: Yeah, but neither of the results are for the page that actually documents the user permissions… :grimacing:

@jkuester are the results returned for user permissions in line with what you were looking for? Trying to figure out what level of prompt detail the search feature needs.

Yes! Those are pretty much exactly what I want to find. :+1:

1 Like