-
Notifications
You must be signed in to change notification settings - Fork 13
Product update: new search experience #418
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
Open
grossyoan
wants to merge
7
commits into
main
Choose a base branch
from
product-update-new-search
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
05d3152
initial commit
grossyoan d8a3f82
Feedback resolved
grossyoan 9f34c00
content splitted to give more clarity
grossyoan 6e56043
Added real examples for scripts
grossyoan ee81c04
Merge remote-tracking branch 'origin/main' into product-update-new-se…
grossyoan a9872d9
initial commit
grossyoan c7eb449
typos corrected
grossyoan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| title: New search experience | ||
| tags: [New] | ||
| image: /images/changelog/new_search_experience.png | ||
| --- | ||
|
|
||
|  | ||
|
|
||
| Search is at the core of our doc portal experience: your users need to easily find what they're looking for, as it's a key part of their API discovery. | ||
|
|
||
| We recently completely rebuilt it to make it more relevant, faster, and more reliable. | ||
|
|
||
| ### Relevance | ||
| - We now display a single list of results instead of several categories: users mostly look for operations, so displaying properties and other content "by default" didn't always make sense. | ||
| - That global result list is ordered based on how closely the query matches a result item, and on its type. For example, for the same result weight, an operation will be favored over a property, | ||
| - The depth of a result is also taken into consideration to calculate its relevance, because we know that a first-level property is generally more important (and therefore searched) than a deep property, | ||
| - We removed the 5 results per type limit and now return all relevant results. | ||
|
|
||
| ### Usability | ||
| - Typos are now better managed and processed to return relevant results, | ||
| - The result item hierarchy has been reworked to increase readability. | ||
|
|
||
|  | ||
|
|
||
| ### Performance | ||
| On average, search speed has been increased by a factor of 7. This is particularly visible on larger hubs and complex documentations, moving from almost a second to a few hundred milliseconds. | ||
|
|
||
| *New search: in this example, the search request takes 43 ms.* | ||
|  | ||
|
|
||
|
|
||
| *Old search: in this example, the search request takes 306 ms.* | ||
|  | ||
|
|
||
|
|
||
|
|
||
| Any feedback? Reach out at [hello@bump.sh](mailto:hello@bump.sh)! | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a small suggestion: would that make sense to create a single gif with the two animations side by side, for a better comparison?