Benchmarkdotnet: [Discussion] Improve search experience in the documentation

[Ant-hem]

Hi team :wave:,

I am member of the .NET foundation and I am working at Algolia on a project called DocSearch which goal is to enhance documentation websites with exhaustive, fast and relevant search. You might have seen DocSearch live already on websites like brew, Bootstrap, React or jQuery.

I have created a preview of the search experience and what DocSearch on the BenchmarkDotNet
website could will look like here. Feel free to try it and let us know what you think. Please not the learn-as-you-type experience and the typo tolerance:

The way DocSearch works is by crawling your content, pushing the results into an Algolia index, and then requesting this index directly from the website front-end through JavaScript.

We'll take care of crawling your website and populating the Algolia index with the latest changes every 24h for you. You don't need to change anything to your deployment process. The only thing you need to add are the following CSS and JS snippets that will bind the dropdown to your searchbox.

We built DocSearch with the idea of giving back to the Open-Source community. This is why your crawling configuration is available on GitHub if you want to change it. We also have our own documentation to help you tweak the dropdown to your needs. You'll also have access to analytics on the most searched terms or those with no results. All of this is of course entirely free.

[AndreyAkinshin]

Hello @Ant-hem!

Thank you very much for this issue, search in your live preview works super fast! It will be awesome to integrate it with our official docs! I have only one concern about the search results: sometimes it doesn't include some important pages. Let's try to search for "orderers". Here is the current search output:

As you can see, it found the "Orderers" page. And here is the output in your live demo:

However, we have the index for the "Article" pages:

If we can resolve this problem somehow, I will be happy to accept a PR with DocSearch integration!

[s-pace]

👋 @AndreyAkinshin ,

Sure done thanks to this update. Feel free to provide us a sitemap so that we do not miss anything.

Can you point us out a repo on which we can offer you a PR. We need to be able to build the html pages.

🚀

[AndreyAkinshin]

@Ant-hem, @s-pace sitemap.xml is ready (URL: https://benchmarkdotnet.org/sitemap.xml, source: https://github.com/dotnet/BenchmarkDotNet/blob/gh-pages/sitemap.xml)

We keep docs sources in this repo and use docfx to build it.
Here is the template for page headers: https://github.com/dotnet/BenchmarkDotNet/blob/master/docs/template/partials/head.tmpl.partial
See also: https://benchmarkdotnet.org/articles/contributing/documentation.html

[s-pace]

PR done https://github.com/dotnet/BenchmarkDotNet/pull/1148 @AndreyAkinshin cc @shipow @adamsitnik

[AndreyAkinshin]

Resolved in #1148

[AndreyAkinshin]

Gif demo with final version:

[Ant-hem]

Looks great! I can't wait to see it live.

[AndreyAkinshin]

@Ant-hem it's already live!