Open Pabl0cks opened 1 year ago
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
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 🙌
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
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
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:
@easyops-cn/docusaurus-search-local',
Found another website using the same local search plugin => CourierUpdate: Just realized ethereum.org docs is also using DocSearch but without Algolia reference.