Add search bar to Bandada docs

[vplasencia]

Description

Add Algolia DocSearch.

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

[JoshdfG]

i would love to do this

[vplasencia]

Hey @JoshdfG! Yes, sure. Would you like me to assign you this issue?

[JoshdfG]

Yes Please

[JoshdfG]

Yes but then where on the page do you want the search bar to be
I looked into it just now

[vplasencia]

@JoshdfG I just assigned you the issue. Thanks.

Yes but then where on the page do you want the search bar to be
I looked into it just now

It would be similar to this website: https://docs.semaphore.pse.dev/

Let us know if you have more questions.

[vplasencia]

@JoshdfG

We have to apply to the DocSearch program as mentioned in the docs, but feel free to start with the user interface.

[JoshdfG]

I still have more questions, do you like need a new page like the website you sent to me? what should be the content? and how should it be done so i can know how well to carry this out.. i just need clarity

should i just extract the texts here and put there or what exactly do you want me to do??

[vplasencia]

Hey @JoshdfG

More context

The idea of this issue is to integrate Algolia DocSearch. This is an input field to add text and find information in the docs easier.

It is a small input text that you can see in the header of these websites:
https://docs.semaphore.pse.dev/
https://docusaurus.io/docs/search#using-algolia-docsearch

This is what it looks like:

Important update: We applied to the DocSearch program. When we have the appId, apiKey and indexName we will let you know to update these values.

How to integrate it

You can read more in the docs. The link is in the issue description.

These would be the steps to integrate it into Bandada.

1- Add the search input text.

To do this, copy this code here https://github.com/semaphore-protocol/semaphore/blob/main/apps/docs/docusaurus.config.ts#L120-L125 and paste it here https://github.com/bandada-infra/bandada/blob/main/apps/docs/docusaurus.config.ts#L129

Then you should see a search bar in the header like on the other websites.

Feel free to use those values to test, we will update them when we have the right ones.

2- Modify the styles.

The input text will have some default styles. It would be nice to have a style similar to the page, then you can copy the css code that is here https://docusaurus.io/docs/search#styling-your-algolia-search and paste it here https://github.com/bandada-infra/bandada/blob/main/apps/docs/src/css/custom.css#L42

Then you will see that the style of the search bar is different when you click on it.

Those are the two steps to solve this issue. The 3rd one would be to update the algolia values (appId, apiKey and indexName) to use the right ones when we have them.

I hope this helps. Please, let us know if you have more questions.

[vplasencia]

Hey @JoshdfG!

Update: Bandada has appId, apiKey and indexName now.

[JoshdfG]

I understand your point and the issue but my question is do you want a single page for it or do you need to see the search bar on that same page? That's because I noticed that there's a search bar on the header of the present page... Once this is answered I'll work on the project. So sorry if the questions seem to me too much, It's just for clarity.

…

On Wed, 1 May 2024 at 22:21, Vivian Plasencia ***@***.***> wrote: Hey @JoshdfG <https://github.com/JoshdfG>! Update: Bandada has appId, apiKey and indexName now. — Reply to this email directly, view it on GitHub <#476 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A6FIISQMWNKTUUCMPR757TDZAFMFVAVCNFSM6AAAAABF3EU43CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOBZGE2TSMRXHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[vplasencia]

Hey @JoshdfG

The search bar should be in the header of the website, in a way that no matter the page you're visiting, you will be able to see it. The header is the default position when you start integrating the search bar using the step one in the previous steps here: #476 (comment).

Then, there is no need to change position because the search bar should be in the header and that's the default position when you integrate it.

Does this answer your question? Please let me know if it's still unclear.

[vplasencia]

Hey @JoshdfG just to follow up on this. Do you need help with something?

[JoshdfG]

I'll on it by tomorrow evening, I've been really busy with work sorry for the delay

…

On Wed, 8 May 2024 at 12:30, Vivian Plasencia ***@***.***> wrote: Hey @JoshdfG <https://github.com/JoshdfG> just to follow up on this. Do you need help with something? — Reply to this email directly, view it on GitHub <#476 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A6FIISXAIWOBWRZQR7UUHQLZBIEF3AVCNFSM6AAAAABF3EU43CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBQGM3DKOBZGQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[vplasencia]

@JoshdfG! No worries, I just wanted to check if everything was fine. Thanks for the response.

[JoshdfG]

Everything is fine, Thanks for checking up, means a lot

…

On Wed, 8 May 2024 at 13:05, Vivian Plasencia ***@***.***> wrote: @JoshdfG <https://github.com/JoshdfG>! No worries, I just wanted to check if everything was fine. Thanks for the response. — Reply to this email directly, view it on GitHub <#476 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A6FIISQCNP2XTTG36ZBP2VLZBIIKDAVCNFSM6AAAAABF3EU43CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBQGQZDMOJSGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>