Skip to content

Update search to DocSearch v3 #1

Closed
s-pace wants to merge 11 commits into
masterfrom
feat/docsearch-v3-draft
Closed

Update search to DocSearch v3 #1
s-pace wants to merge 11 commits into
masterfrom
feat/docsearch-v3-draft

Conversation

@s-pace
Copy link
Copy Markdown
Owner

@s-pace s-pace commented Aug 19, 2020

👋🏻 Popper team!

This PR integrates the new version of DocSearch, that better reflects what we think documentation search should be.

Description:

Reducing users' efforts to get them started integrating your product is key to adoption. We created DocSearch in 2015 as a community effort to solve this problem.

We've had time to try different approaches since then and would like to propose you a new documentation search experience.

This new experience has been well received and is now live on the Docusaurus v2 integration: facebook/docusaurus#2815.

Preview:

Preview.

Mobile Desktop
Preview on Mobile  Preview on Desktop

Changes:

You can read about all the new features in the Docusaurus PR , but here's a summary:

  • We replaced the dropdown list for a modal
  • You can open the search modal with Ctrl + K, ⌘ + K or /
  • No hard refresh (we leverage the Gatsby navigation API in this integration)
  • The experience works on mobile and is close to a native mobile experience
  • Recent searches
  • Favorite searches
  • Selection search
  • Search suggestions
  • Offline detection
  • The bundle size decreased and we now provide React components which can be lazy loaded.
  • Filtering ont the version depending of the page i.e. searching from a v1 page will only search for v1 documentation

What's next

This new DocSearch version has been used in production for a couple of weeks now, on the DocSearch website and on a few Docusaurus v2 integrations.

This version is marked as alpha for now because the underlying libraries that we use (e.g., autocomplete-core) are still being worked on at @algolia to make sure that it handles more cases than DocSearch and usual autocomplete search experiences. We plan to go stable in the coming weeks but no major changes will happen to DocSearch.

Let us know what you think!

@s-pace s-pace force-pushed the feat/docsearch-v3-draft branch from 620e247 to 88f06da Compare August 20, 2020 12:28
@s-pace s-pace closed this Aug 25, 2020
@s-pace s-pace deleted the feat/docsearch-v3-draft branch August 25, 2020 09:44
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.

1 participant