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

Integrate Algolia Search into Subspace Documentation #462

Merged
merged 5 commits into from Mar 27, 2024

Conversation

ImmaZoni
Copy link
Contributor

Introduction

This pull request introduces Algolia Search as a new feature in the Subspace documentation, marking the first time a search functionality has been implemented to enhance the accessibility and user experience of the documentation site.

Objectives

  • To provide immediate, relevant search results to users navigating the Subspace documentation.
  • To lay the foundation for scalable, powerful search capabilities as the documentation grows.

Implementation Overview

Algolia was selected for its excellence in search performance, user-friendly integration, and comprehensive analytics. This initial implementation includes:

  • Configuring Algolia to index the Subspace documentation content.
  • Embedding the Algolia search bar and results display into the documentation site's layout.
  • Tailoring the search experience to match the needs and expectations of the Subspace community.

Algolia Account and Management

An Algolia account has been set up for the purpose of this feature implementation. I am prepared to hand over control of this account to the Subspace team, ensuring a seamless transition and continuous management of the search functionality.

Key Benefits

  • Enhanced User Experience: Users can now quickly find the information they need, improving their learning and troubleshooting experience.
  • Scalability: Algolia provides a robust platform that can grow with the Subspace documentation, accommodating future expansions seamlessly.
  • Analytics Insights: The Algolia dashboard offers valuable insights into search patterns, which can be used to further improve the documentation.

Copy link

netlify bot commented Mar 14, 2024

Deploy Preview for subspace-docs-staging ready!

Name Link
🔨 Latest commit 32c4cc2
🔍 Latest deploy log https://app.netlify.com/sites/subspace-docs-staging/deploys/6604310c5c7efc00084d8a85
😎 Deploy Preview https://deploy-preview-462--subspace-docs-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@EmilFattakhov EmilFattakhov self-requested a review March 16, 2024 23:47
@EmilFattakhov EmilFattakhov self-assigned this Mar 16, 2024
@EmilFattakhov
Copy link
Contributor

EmilFattakhov commented Mar 19, 2024

It's great to see a contribution from you @ImmaZoni ❤️‍🔥
At the moment, the preview is not building because the node version we're using is incompatible with the Algolia plugin. The search bar also does not appear locally, which is likely related. Let me update the node version so we can test your PR!

@EmilFattakhov
Copy link
Contributor

Hope you don't mind me pushing the required node version directly at your PR 😉, it's just faster to check if it compiles this way.

@EmilFattakhov
Copy link
Contributor

@ImmaZoni I believe the indexing might have not been done yet, please try performing a search and check the logs. I can help debug if you share the algolia credentials with me :)

@ImmaZoni
Copy link
Contributor Author

Hey @EmilFattakhov! From my understanding of the Algolia docs i don't think it will index until it hits production. I will send you a Discord DM with the credentials for Algolia so we can take a look 🙏

Copy link
Contributor

@EmilFattakhov EmilFattakhov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're right in the assumption that we need to merge it to production first Justin, giving this a try and re-open the PR in case something is missing. Thank you so much for your PR @ImmaZoni, and hope to see more PRs from you!

@EmilFattakhov EmilFattakhov merged commit 1da6c11 into subspace:main Mar 27, 2024
4 of 5 checks passed
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

Successfully merging this pull request may close these issues.

None yet

2 participants