Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

docs(search): proposal for a new search experience using DocSearch 📄 #2377

Closed
wants to merge 1 commit into from

Conversation

vvo
Copy link

@vvo vvo commented Sep 16, 2016

Hi,

This PR is a proposal to change the default search feature of https://angular.io to DocSearch.

We believe this change offers a better search experience for AngularJS developers than the
current search feature.

DocSearch is built by Algolia. It's free. You do not have to maintain it. We built it as a community effort
to bring good documentation search to developer communities. It is installed on 160+ websites,
maybe you already used it while browsing https://facebook.github.io/react/ or http://vuejs.org/api/.

@maxiloc and @vvo (me) did the DocSearch integration for angular.io, we work at @algolia.

Here's a demo of how it looks:
angular io

Differences with the current search:

  • Isolates searches by language. If you are on /docs/dart then you only get the relevant search results for this language.
  • Typo tolerance. Write ngnodule, we correct that to ngmodule
  • Direct access to corresponding paragraph if a query matches one. Example: architecture components will directly scroll to guide/architecture.html#components
  • Wider search results style allowing for a more comfortable experience
  • Performance. This is subjective but you can maybe tell from the GIF that we show results at the first keystroke which is not the case today

angular.io search index is replicated in 10 regions in the world like any DocSearch index, bringing good search performance to most users.

If the ranking does not meet your expectations, we can tune it. I am sure, as AngularJS developers, you already know what would be a perfect ranking/display for a good search. We can tune it in many ways but we believe it could be ok for a first start.

I hope you appreciate this PR and the work we put on making the search on https://angular.io/ AWESOME :)

@vvo vvo changed the title docs(search): switch documentation to DocSearch, a new search experience 📄 docs(search): proposal for a new search experience using DocSearch 📄 Sep 16, 2016
@naomiblack
Copy link
Contributor

cc'ing some interested parties... we've been looking at tuning search which has sorely languished these past few months. thanks for the PR. we'll have a look.

@vvo
Copy link
Author

vvo commented Sep 21, 2016

Thanks @naomiblack, any feedback yet? You must be all busy with the official release eheh :)

@xorgy
Copy link

xorgy commented Oct 3, 2016

This looks beautiful. Search is the first thing I see people groan about when they visit the docs.

@vvo
Copy link
Author

vvo commented Oct 21, 2016

Ping @naomiblack @alexwolfe @robwormald. I think you recently upgraded search with 5732b07. If this PR is no more relevant, feel free to close it.

Thanks

@vvo
Copy link
Author

vvo commented Oct 21, 2016

If you also want a result page with DocSeach, I can provide it. Right now the result page on angulario shows both autocompletion menu and results at the same time:

2016-10-21-085254_1391x1154_scrot

Also when switching languages in the left menu, it does not refine the left search.

@vvo
Copy link
Author

vvo commented Nov 8, 2016

Hey hi, any news here? Do you want to maybe either close or merge this? Thanks!

@vvo
Copy link
Author

vvo commented Feb 28, 2017

Closing, if anyone from angular is interested in restarting this, just ping me here

@vvo vvo closed this Feb 28, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants