feat(search): update search to DocSearch v3 #2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
s-pace
force-pushed
the
feat/docsearch-v3
branch
from
4ccf48c
to
9b9442d
Compare
francoischalifour
suggested changes
Aug 24, 2020
Co-authored-by: François Chalifour <francoischalifour@users.noreply.github.com>
s-pace
force-pushed
the
feat/docsearch-v3
branch
from
c60fca5
to
8da678d
Compare
added 7 commits
August 25, 2020 11:19
…ved if francoischalifour/autocomplete#75 is deployed
francoischalifour
approved these changes
Aug 25, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
👋🏻 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:
Changes:
You can read about all the new features in the Docusaurus PR , but here's a summary:
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!