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

Add Search feature #6

Open
Pabl0cks opened this issue Aug 1, 2023 · 3 comments
Open

Add Search feature #6

Pabl0cks opened this issue Aug 1, 2023 · 3 comments
Assignees

Comments

@Pabl0cks
Copy link
Collaborator

Pabl0cks commented Aug 1, 2023

When we have initial version of Docs in production, could be interesting to add a search bar.

Docusaurus docs offer a few options for that:

Algolia DocSearch is free for open-source projects, just have to apply to the DocSearch program. I guess we shouldn't have problems getting accepted.

A few examples of other projects:

  • Uniswap Docs is using Algolia DocSearch
  • Solana uses Algolia too.
  • Chia Docs is using a local search => @easyops-cn/docusaurus-search-local', Found another website using the same local search plugin => Courier
  • Celo uses Algolia DocSearch but removed Search by Algolia logo
  • Flow was using algolia and removed it 12 hours ago 🧐

Update: Just realized ethereum.org docs is also using DocSearch but without Algolia reference.

@technophile-04 technophile-04 self-assigned this Aug 11, 2023
@technophile-04
Copy link
Collaborator

I was just trying to do some comparison b/w Aloglia and Typesense and found this: https://typesense.org/typesense-vs-algolia-vs-elasticsearch-vs-meilisearch/

On Dev Side :

Typesense Algolia DocSearch
We will be needing to host the server or use typesense cloud service which both has some cost Alogolia DocSearch is completely free for OSS tool documentation and they take care of all this

Overall I am kind of leaning toward Algolia DocSearch due to its

  1. simplicity on our end
  2. since its widely adopted many plugins/tools support or have documentation for Algolia DocSearch out-of-box

Question :
Do we need a search feature in the current situation? Like I see currently the docs are pretty intuitive and easily navigable / short. But we will be needing to make decisions in future (we can wait for Carlos if the docs remains short until he comes for the decesion 🙌 )

But please feel free to suggest your thoughts 🙌

@carletex
Copy link
Member

Question :
Do we need a search feature in the current situation? Like I see currently the docs are pretty intuitive and easily navigable / short. But we will be needing to make decisions in future (we can wait for Carlos if the docs remains short until he comes for the decesion 🙌 )

I agree with this. It's not a huge doc site (at least for now), so the search feature is not critical. Maybe we could defer this a bit... unless someone really likes the idea and wants to implement it :D

@FilipHarald
Copy link
Contributor

I checked out the local-search alternatives. I only got one to work, it's rudimentary but gets the job done. This indexes the pages during build, but after that no additional services needs to be hosted. I made a working example here: https://github.com/FilipHarald/se-2-docs/tree/feat/serch_bar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants