bee-docs icon indicating copy to clipboard operation
bee-docs copied to clipboard

Replace search with Algolia based one

Open AuHau opened this issue 3 years ago • 4 comments

Looking at other Docusaurus based documentation they almost always use the Algolia based search platform which is IMHO much better and nicer than the one we use. I would suggest replacing it.

https://docusaurus.io/docs/search#using-algolia-docsearch

AuHau avatar Apr 06 '22 14:04 AuHau

cc @ethersphere/js

AuHau avatar Apr 06 '22 14:04 AuHau

Good suggestion but I think we should have usability vs ideology discussion.

I was looking at Algolia when we started with the bee-js-docs. At that point I decided that we probably don't want to add a centralised solution. Especially if our goal is to host it (purely) on Swarm in future. IMHO the current search is good enough while working without 3rd party service.

vojtechsimetka avatar Apr 06 '22 23:04 vojtechsimetka

indeed this decision was made to avoid reliance on centralised services and so we can upload in a self contained way to swarm. @AuHau perhaps we can begin to discuss what you prefer about the Algolia search choice and we can try to implement it in the forthcoming design improvements.

significance avatar Jun 03 '22 08:06 significance

Yeah, I though that might be the case. Honestly, I don't really need Algolia per se, but I really love a few things that they have in their implementations:

  • the modal search window (but I could get over that one)
  • generally looks nicer 😅
  • the cmd+k / ctrl+k shortcut that focus the search bar (and the fact that a note about this is present in the search bar) image

AuHau avatar Jun 03 '22 08:06 AuHau