readthedocs / readthedocs-sphinx-search

Deprecated: Enable search-as-you-type feature for docs hosted by RTD.
https://readthedocs-sphinx-search.readthedocs.io/
MIT License
33 stars 16 forks source link

Search popup is unwieldy on desktop (considere using a drop down menu) #73

Closed stijn-h closed 5 months ago

stijn-h commented 4 years ago

Searching is not a pleasant experience, and it's mainly because of a slow, (assumably) mobile-first search popup. While I can't speak for every documentation website, at least for the repository I'm working with (Godot Engine), desktop monitors should be the primary device to target for user experience. Example in the Godot Engine docs:

search_godot

A better instant search would only take up a modest amount of space under the search bar, and not take away the ability to use the current page. This would likely imply different search UI on mobile and desktop devices.

stsewd commented 4 years ago

and it's mainly because of a slow, (assumably) mobile-first search popup

Do you mean the transition is slow? It should be faster now https://github.com/readthedocs/readthedocs-sphinx-search/pull/66

A better instant search would only take up a modest amount of space under the search bar, and not take away the ability to use the current page. This would likely imply different search UI on mobile and desktop devices.

Some other sites like mkdocs have the modal window like this as well https://www.mkdocs.org/.

I guess we can have something like an option to minimize the modal window?

stijn-h commented 4 years ago

Those changes should help, but I still feel that it leaves much to be desired. I guess the idea behind the large popup is that search results aren't single line suggestions like in a usual drop down. However, even in the smaller example you gave, it prevents you from using or reading the current page you are on while searching.

stsewd commented 4 years ago

Those changes should help, but I still feel that it leaves much to be desired

Do you mean related to speed?

However, even in the smaller example you gave, it prevents you from using or reading the current page you are on while searching.

Which example? Do you mean the mkdocs search?

stijn-h commented 4 years ago

Do you mean the mkdocs search?

Yes. I would prefer a list of search suggestions that dont take away control from the webpage, like in this example.