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

[docs] Change Algolia search implementation #26112

Closed
1 task done
oliviertassinari opened this issue May 3, 2021 · 10 comments · Fixed by #28252
Closed
1 task done

[docs] Change Algolia search implementation #26112

oliviertassinari opened this issue May 3, 2021 · 10 comments · Fixed by #28252
Labels
docs Improvements or additions to the documentation new feature New feature or request priority: important This change can make a difference

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented May 3, 2021

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Redo the integration with Algolia's API.

Examples 🌈

Screenshot 2021-05-04 at 01 33 05

https://popper.js.org/react-popper/

Regarding how we will display the search bar, something we have pocked with for desktop and mobile.

desktop

mobile

Motivation 🔦

The new interface of https://github.com/algolia/docsearch is similar to Spotlight on macOS, it yields a better UX than the current one.

In the future, we could even consider internalizing this component, I have seen https://blueprintjs.com/docs/versions/4/#select/omnibar do it, but it's unlikely something we want to consider now as the objective is to do a quick win, without involving a designer.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label May 3, 2021
@arpitBhalla
Copy link
Contributor

@oliviertassinari May I work on this?

@oliviertassinari
Copy link
Member Author

@arpitBhalla I was thinking that @siriwatknp could be working on it, I think that he can supervise the effort, so up to him :)

@siriwatknp
Copy link
Member

siriwatknp commented May 11, 2021

@arpitBhalla please go ahead if you like, I can help on the review and answer question if you have any.

@arpitBhalla
Copy link
Contributor

Thanks @siriwatknp

@oliviertassinari
Copy link
Member Author

@arpitBhalla Do you have any updates? This one is important for the DX on the documentation as well as our brand, this looks neglected:

Screenshot 2021-05-19 at 14 43 12

@arpitBhalla
Copy link
Contributor

arpitBhalla commented May 19, 2021

@siriwatknp @oliviertassinari Popper js website uses @docsearch/react, Should I have to install this, or I have to use Mui's Dialog, or edit the already available css. Please Guide

@oliviertassinari
Copy link
Member Author

oliviertassinari commented May 19, 2021

I was thinking of salvaging what we can from @docsearch/react. It seems that it would already be a great improvement over what we have. It's the natural upgrade path Algolia is proposing.

Maybe we could push it even further with our own components but hard to tell how without understanding how docsearch is falling short, first. It's also not clear if we have the bandwidth to make something great ourselves (it has to be above average).

@arpitBhalla
Copy link
Contributor

It's also not clear if we have the bandwidth to make something great ourselves (it has to be above average).

So it would be great to use @docsearch/react for now, I guess

@arpitBhalla
Copy link
Contributor

Screenshot-20210520002520-1366x768

@oliviertassinari
Copy link
Member Author

It looks like an interesting start. Note that we will also render it in https://next.material-ui.com/branding/about/ afterwards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation new feature New feature or request priority: important This change can make a difference
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants