Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the search results layout #76

Open
settermjd opened this issue May 16, 2019 · 0 comments
Open

Update the search results layout #76

settermjd opened this issue May 16, 2019 · 0 comments

Comments

@settermjd
Copy link
Contributor

settermjd commented May 16, 2019

After talking with @voroyam, I propose making two changes to the search results structure to make them easier for users to read; specifically, these are:

  1. Group search results by documentation version
  2. Remove the "Score" information

Group Search Results by Documentation Version

In the screenshot below, you can see the current ownCloud docs search results on the left, and the Antora documentation search results on the right.

search results comparison

I believe that the layout of Antora's search results, or something akin to it, will make it easier for users to find the information that they're looking for, specific to their installed version of ownCloud.
Secondarily, it would be excellent if the search could also top-load the results for the version of the documentation that the user is currently viewing if there are any.

Remove the Score Information

I appreciate that this is information that ElasticSearch stores internally, but from a user perspective, I don't see how it helps the user pick the information most relative to their search query, as the wording isn't necessarily the most intuitive in that regard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant