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

Add algolia search to Docusaurus website #1163

Merged
merged 4 commits into from
Mar 13, 2024
Merged

Conversation

maoo
Copy link
Member

@maoo maoo commented Feb 26, 2024

No description provided.

@maoo maoo requested a review from robmoffat February 26, 2024 10:51
Copy link

netlify bot commented Feb 26, 2024

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit d8799a1
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/65f0656ed0bbdd000824ae0e
😎 Deploy Preview https://deploy-preview-1163--fdc3.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.

Copy link
Member

@robmoffat robmoffat left a comment

Choose a reason for hiding this comment

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

works for me!

@robmoffat robmoffat requested a review from a team March 12, 2024 09:53
@robmoffat
Copy link
Member

Would be good to get some other maintainers to review before merging.

@bingenito
Copy link
Member

I find the results very confusing since they include all versions of the API (for example, search for 'addContextListener'. I'm not sure it makes sense to only index the latest version so maybe it points to the need of different page titles?

Copy link
Contributor

Could turn on contextual search, which will filter to the currently displayed version: https://docusaurus.io/docs/search#contextual-search

Otherwise, its a case of customisation and prominently displaying the version, and/or using custom facet filters. Probably best to try contextual search first as its easy to flip on

@robmoffat
Copy link
Member

let's give it a whirl. Just made the change

@bingenito
Copy link
Member

let's give it a whirl. Just made the change

+1 on this way.

Copy link
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

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

LGTM - it does a good job of breaking down the results into the major sections and filtering to a particular version (currently selected version) is working.

@robmoffat
Copy link
Member

yeah this looks good - merge?

Copy link
Contributor

sure - will leave the joy or pushing the button to you ;-)

@kriswest kriswest merged commit 78a27af into main Mar 13, 2024
7 checks passed
@kriswest
Copy link
Contributor

Too late, pushed the button myself

@kriswest kriswest deleted the algolia-search-setup branch March 13, 2024 14:00
@kriswest
Copy link
Contributor

Thanks for the PR @maoo and @robmoffat

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.

4 participants