coala / meta

A repository for non-code activities, such as engagement initiatives, and other meta issues
6 stars 5 forks source link

Add algolia docsearch to docs #91

Closed meetmangukiya closed 7 years ago

meetmangukiya commented 7 years ago

Current search is simple keyword search. Algolia docsearch does a pretty good job in searching documentations. It is being used at docs.gitlab.com if you are looking for an example

meetmangukiya commented 7 years ago
  1. DocSearch is almost instantaneous and way faster than the one offered by sphinx by default.
  2. It provides live searching i.e. Search results change as you type
yukiisbored commented 7 years ago

Will it work even without javascript?

meetmangukiya commented 7 years ago

No, it most probably uses AJAX for live searching, else it wont work

hemangsk commented 7 years ago

Live search is definitely good. There is also Mkdocs, used for GitMate documentation, which has a similar feature, but that is a different documentation platform altogether. Agolia docsearch looks like a great idea.

jayvdb commented 7 years ago

@yukiisbored , does Sphinx search work without javascript? If so, we'd need to verify DocSearch degrades gracefully.

yukiisbored commented 7 years ago

@jayvdb Actually, i just noticed it won't even show up.

jayvdb commented 7 years ago

What "wont even show up" ?; Sphinx or Agolia DocSearch ?

yukiisbored commented 7 years ago

Sphinx.

Javascript enabled: https://my.mixtape.moe/jvscjw.png Javascript disabled: https://my.mixtape.moe/glzimk.png

yukiisbored commented 7 years ago

Since I can't find any algolia docsearch instance that uses Sphinx. I'm trying it out on Vue.js and the search box came up but I can't search (The Enter button doesn't work, most likely it's handled in JS instead of a HTML Submission form)

meetmangukiya commented 7 years ago

@yukiisbored yes, there is no form submission, it checks if the text in the input box is changed and shows the search results in the dropdown as you type.

jayvdb commented 7 years ago

@meetmangukiya , this is finished?

meetmangukiya commented 7 years ago

Yes