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

feat: add algolia search to docs #445

Merged
merged 2 commits into from
Jan 3, 2025

Conversation

derrekcoleman
Copy link
Contributor

@derrekcoleman derrekcoleman commented Dec 31, 2024

Improve the search experience on our docs pages by switching from native Docusaurus search to Algolia.

Docusaurus has first-class support for Algolia, so this implementation relies on the default config.

  • The notable option is insights: true, which helps us see common searches and results. For example, this can help us discover if users are searching for a page that does not exist yet.

We can view this data and manage our Algolia account from their dashboard. Login details to follow privately.

Example of search UI:
Screenshot 2025-01-03 at 10 39 24 AM

Example of docs.gobob.xyz/search page:
Screenshot 2025-01-03 at 10 39 39 AM

Also including a small commit for formatting lines 186-190, just to get it out of the way.

Copy link

changeset-bot bot commented Dec 31, 2024

⚠️ No Changeset found

Latest commit: f651e16

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 31, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 3, 2025 5:36pm

Copy link

gitguardian bot commented Jan 3, 2025

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
While these secrets were previously flagged, we no longer have a reference to the
specific commits where they were detected. Once a secret has been leaked into a git
repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Add algolia verification to robots.txt

Fix Algolia UI by removing previous component
@derrekcoleman derrekcoleman force-pushed the derrek/docs-add-algolia-search branch from 4c777b3 to f651e16 Compare January 3, 2025 17:35
@derrekcoleman derrekcoleman marked this pull request as ready for review January 3, 2025 17:38
@derrekcoleman derrekcoleman added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 3, 2025
@derrekcoleman derrekcoleman merged commit f0d1cc8 into master Jan 3, 2025
4 of 5 checks passed
@derrekcoleman derrekcoleman deleted the derrek/docs-add-algolia-search branch January 3, 2025 17:45
@derrekcoleman derrekcoleman mentioned this pull request Jan 3, 2025
62 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants