Use Algolia for Guide search

[Bosch-0]

Opening this issue as a place to discuss us upgrading the guide's search engine to using Algolia: https://www.algolia.com/

It will make our search much more advanced and help users find the content relevant to them.

There is also Docsearch which uses Algolia and gives some extra features. It's offered for open-source projects so they can use Algolia for free (Algolia is free up until a certain amount of queries). https://docsearch.algolia.com/

I already have us Docsearch Bitcoin Design account setup fyi

Part of this would mean creating some new UI for the search bar too.

[Bosch-0]

Can address this with this update also: https://github.com/BitcoinDesign/Guide/issues/844

Ran the a11y Netlify plugin on bitcoin.design which tests the site against a11y accessibility standards and received 3 errors all relating to the sites search, no others popped up.

12:25:13 PM: [Search | Bitcoin Design (_site/search.html)] error 1: This form does not contain a submit button, which creates issues for those who cannot submit the form using the keyboard. Submit buttons are INPUT elements with type attribute "submit" or "image", or BUTTON elements with type "submit" or omitted/invalid. (<form action="/search.html" msethod="get">
12:25:13 PM:   <input type="text" id="searc...</form>)
[Search | Bitcoin Design (_site/search.html)] error 1: This textinput element does not have a name available to an accessibility API. Valid names are: label element, title undefined, aria-label undefined, aria-labelledby undefined. (<input type="text" id="search-page-input" name="query">)
12:25:13 PM: [Search | Bitcoin Design (_site/search.html)] error 1: This form field should be labelled in some way. Use the label element (either with a "for" attribute or wrapped around the form field), or "title", "aria-label" or "aria-labelledby" attributes as appropriate. (<input type="text" id="search-page-input" name="query">)

[GBKS]

Using Algolia sounds like a good idea. How about we set up a draft PR to test the quality of the results before we decide?

Docsend seems like overkill. I'd prefer having a simpler, more elegant UI that fits in better with the rest of the site design. Looks like Algolia provides libraries that should make this fairly simple.

[Bosch-0]

Docsearch is pretty much the exact same as Algolia

1. We get it it for free (unlimited queries)
2. They give some out of the box frontend UIs which imo look fine (saves up re-inventing the wheel).

[sbddesign]

The DocSearch might be worth looking into. The unlimited free search they provide for FOSS projects would be a huge value add. I think we add our own styling to the search components by overriding our crafting our own stylesheet.

[Bosch-0]

I got us an account setup that we can use, was a bit of a waiting list to get accepted. They had to verify we are FOSS / educational to get access

[GBKS]

A further interest in this issue? The last activity was 1.5 years ago. We should close this one and open a new issue if someone wants to work on search.