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

Updating the search UI #2147

Closed
Hetarth02 opened this issue Jun 23, 2023 · 4 comments · Fixed by #2202
Closed

Updating the search UI #2147

Hetarth02 opened this issue Jun 23, 2023 · 4 comments · Fixed by #2202
Labels
Format: HTML Related to the default HTML output Type: Enhancement

Comments

@Hetarth02
Copy link
Contributor

Currently the search UI looks like this,

Screenshot_2023-06-24-01-10-20-64_a1b1bbe5f63d5b96c1a0f87c197ebfae.jpg

This doesn't display much information about the search results.

I think that the UI should display more information regarding search results like, what category is this from, where did the term match.

Moreover, rather than having a separate page for searching we should have something like a search modal which can be accessible from anywhere. This would be a lot helpful. We can take inspiration from other documentations and how have they implemented their search UI.

Issue #1437, Issue #1986: These issues also address that the search results should display some more information rather than just the title of the search result.

@Hetarth02
Copy link
Contributor Author

Hetarth02 commented Jun 23, 2023

A demo of what I have in mind is here. Press ctrl + / to quick open the search modal.

I have also made a page having different search mockups. Here is the link.

Feel free to leave any feedback here.

@mortenpi mortenpi added Type: Enhancement Format: HTML Related to the default HTML output labels Jun 25, 2023
@Hetarth02
Copy link
Contributor Author

Update 01 July, 2023.

  • I have added some new mockups. (7 onwards)

@mortenpi
Copy link
Member

mortenpi commented Jul 5, 2023

I think I like 11 the most out of those ones. I think the overall layout there makes sense. So we could take that and start iterating on it in a fully functional demo (or even start integrating it into Documenter).

image

@Hetarth02
Copy link
Contributor Author

PR #2172 gives some insight as to what the new UI might look like.

I have updated the default list view for the time being and will be working on the search modal along with improving the UI based on your feedbacks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output Type: Enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants