[WIP] Add Search Bar to Navbar to Improve User Experience

[divine7022]

Fixed: #90

This pull request adds a search bar to the navbar, improving the user experience by allowing quick access to site content via search. This addresses the need for enhanced navigation outlined in #90

Before:

After:

[divine7022]

@dlebauer let me know if any further modifications are needed.

[dlebauer]

Hi @divine7022 thanks for this contribution. Lets continue the discussion in #90

[dlebauer]

@divine7022 could you please resolve conflicts in yarn.lock?

[divine7022]

Thanks for noticing! I'll review and resolve the conflicts soon.

[divine7022]

@dlebauer @allgandalf
Hello Sir,
I’ve fixed the indexing issue of the develop branch. Could you please merge it?
This merge is solely for testing purposes to verify if indexing works correctly with the production domain, which I couldn’t confirm on localhost.

Once if it worked, I’ll proceed to implement debouncing and address a few other things need to be fixed for the search functionality.

Thanks!

[dlebauer]

@divine7022 thanks for resolving the conflicts.

Are these API keys supposed to be checked in, or should they be stored as github secrets?

[divine7022]

Thanks for your feedback!

The current key in use is a search-only Algolia API key, which is safe for frontend usage. However, to follow best practices and keep the repository clean, could you please add apiKey to the repository’s gh secrets? And appId might change while testing if required; so, since the appId is less sensitive, i think we can commit appId for time being.

Name: ALGOLIA_API_KEY
05b54936b63721c91805e55ec170ae6b

Once it’s added, I’ll update the workflow to reference this secret accordingly.

[infotroph]

1. This is a public discussion, so everything posted here is no longer a secret.
2. It looks like you're adding keys for a service that we decided in Enhance Site Navigation: Add Search Bar to Navbar #90 not to use. Was there followup discussion elsewhere that changed that decision?

[divine7022]

Thanks for your feedback!

There hasn’t been any other discussion apart from #90
I explored a few open source alternatives for implementing search, but most of them are better suited for static site content. Since our documentation is served from another repository, those didn’t work as expected after try using them.

That’s why I revisited the Algolia based approach and fixed the issue occurring with the indexes of the develop branch. I thought we could move forward with this if debouncing worked.

Please let me know if you have any other preferences.

[divine7022]

as an another option, since bookdown already provides a basic search for docs by default, could we stick with open source temporarily ?