riptano / docs-ui

The UI and theme for DataStax Docs.
https://riptano.github.io/docs-ui/
Mozilla Public License 2.0
2 stars 0 forks source link

Site search enhancements #142

Open eric-schneider opened 3 weeks ago

eric-schneider commented 3 weeks ago

Our current site search is powered by Algolia DocSearch. DocSearch is an off-the-shelf collection of a couple different Algolia components, optimized for relatively small documentation websites. DocSearch is way better than our previous Algolia implementation in almost every respect, including better/faster search results, as well as pre-built UI that comes has keyboard shortcuts and accessibility features.

However, although DocSearch is very powerful and easy to implement out of the box, it lacks customizability. In particular, it doesn't provide filtering and really allow for rich UI customization beyond color and component sizing.

We need to take a comprehensive look at our current site search experience to determine whether we want to make any further UX/UI enhancements (including product filtering) and create a list of those requirements. Once we have those requirements, we need to assess whether it's possible to satisfy those those requirements using DocSearch. If DocSearch isn't up to the task, then we'll need to build a new search experience from the ground up using standard Algolia components.