Search by Algolia
8 ways to use merchandising data to boost your online store ROI
e-commerce

8 ways to use merchandising data to boost your online store ROI

New year, new goals. Sounds positive, but looking at your sales data, your revenue and profit aren’t so hot ...

John Stewart

VP, Corporate Communications and Brand

Algolia DocSearch + Astro Starlight
engineering

Algolia DocSearch + Astro Starlight

What is Astro Starlight? If you're building a documentation site, your content needs to be easy to write and ...

Jaden Baptista

Technical Writer

What role does AI play in recommendation systems and engines?
ai

What role does AI play in recommendation systems and engines?

You put that in your cart. How about this cool thing to go with it? You liked that? Here are ...

Catherine Dee

Search and Discovery writer

How AI can help improve your user experience
ux

How AI can help improve your user experience

They say you get one chance to make a great first impression. With visual design on ecommerce web pages, this ...

Jon Silvers

Director, Digital Marketing

Keeping your Algolia search index up to date
product

Keeping your Algolia search index up to date

When creating your initial Algolia index, you may seed the index with an initial set of data. This is convenient ...

Jaden Baptista

Technical Writer

Merchandising in the AI era
e-commerce

Merchandising in the AI era

For merchandisers, every website visit is an opportunity to promote products to potential buyers. In the era of AI, incorporating ...

Tariq Khan

Director of Content Marketing

Debunking the most common AI myths
ai

Debunking the most common AI myths

ARTIFICIAL INTELLIGENCE CAN’T BE TRUSTED, shouts the headline on your social media newsfeed. Is that really true, or is ...

Vincent Caruana

Senior Digital Marketing Manager, SEO

How AI can benefit the retail industry
ai

How AI can benefit the retail industry

Artificial intelligence is on a roll. It’s strengthening healthcare diagnostics, taking on office grunt work, helping banks combat fraud ...

Catherine Dee

Search and Discovery writer

How ecommerce AI is reshaping business
e-commerce

How ecommerce AI is reshaping business

Like other modern phenomena such as social media, artificial intelligence has landed on the ecommerce industry scene with a giant ...

Vincent Caruana

Senior Digital Marketing Manager, SEO

AI-driven smart merchandising: what it is and why your ecommerce store needs it
ai

AI-driven smart merchandising: what it is and why your ecommerce store needs it

Do you dream of having your own personal online shopper? Someone familiar and fun who pops up every time you ...

Catherine Dee

Search and Discovery writer

NRF 2024: A cocktail of inspiration and innovation
e-commerce

NRF 2024: A cocktail of inspiration and innovation

Retail’s big show, NRF 2024, once again brought together a wide spectrum of practitioners focused on innovation and transformation ...

Reshma Iyer

Director of Product Marketing, Ecommerce

How AI-powered personalization is transforming the user and customer experience
ai

How AI-powered personalization is transforming the user and customer experience

In a world of so many overwhelming choices for consumers, how can you best engage with the shoppers who visit ...

Vincent Caruana

Senior Digital Marketing Manager, SEO

Unveiling the future: Algolia’s AI revolution at NRF Retail Big Show
algolia

Unveiling the future: Algolia’s AI revolution at NRF Retail Big Show

Get ready for an exhilarating journey into the future of retail as Algolia takes center stage at the NRF Retail ...

John Stewart

VP Corporate Marketing

How to master personalization with AI
ai

How to master personalization with AI

Picture ecommerce in its early days: businesses were just beginning to discover the power of personalized marketing. They’d divide ...

Ciprian Borodescu

AI Product Manager | On a mission to help people succeed through the use of AI

5 best practices for nailing the ecommerce virtual assistant user experience
ai

5 best practices for nailing the ecommerce virtual assistant user experience

“Hello there, how can I help you today?”, asks the virtual shopping assistant in the lower right-hand corner ...

Vincent Caruana

Senior Digital Marketing Manager, SEO

Add InstantSearch and Autocomplete to your search experience in just 5 minutes
product

Add InstantSearch and Autocomplete to your search experience in just 5 minutes

A good starting point for building a comprehensive search experience is a straightforward app template. When crafting your application’s ...

Imogen Lovera

Senior Product Manager

Best practices of conversion-focused ecommerce website design
e-commerce

Best practices of conversion-focused ecommerce website design

The inviting ecommerce website template that balances bright colors with plenty of white space. The stylized fonts for the headers ...

Catherine Dee

Search and Discovery writer

Ecommerce product listing pages: what they are and how to optimize them for maximum conversion
e-commerce

Ecommerce product listing pages: what they are and how to optimize them for maximum conversion

Imagine an online shopping experience designed to reflect your unique consumer needs and preferences — a digital world shaped completely around ...

Vincent Caruana

Senior Digital Marketing Manager, SEO

Looking for something?

facebookfacebooklinkedinlinkedintwittertwittermailmail

Developer eXperience, known as DX, is key to building great software, as it helps your developer-users leverage the best out of your software.

Part of good DX is searching through documentation, not only as a means to finding information, but also as a tool to structure technical content. In this article we show you a how a simple project – Algolia’s free DocSearch platform – has come to solve a common pain point in the open source community: that of searching and structuring documentation. We show the positive impact of DocSearch as well as the cost in developing it.

We also focus on the value of search as compared to the widely used Ctrl+F

Finally, we present some ideas we have about how to make DocSearch even more helpful.

Making Documentation Easy for Developers

The developer community is growing fast. Their impact is broader and stronger. We wanted to use our search technology to help developers do their magic and make this world a better place. It was time to focus on a proper DX. 

That’s where Algolia and its DocSearch tool comes in: making search come alive with a learn-as-you-type experience.

Search solves a regular issue: every developer needs to use documentation whenever they need to learn or use new technology. Search brings love to a project. But most projects have limited resources, or they lack the knowledge to create a good search experience for their documentation. They focus on building an amazing tool. DocSearch makes their documentation come alive – for free and out of the box. 

DocSearch has been warmly welcomed in the community. It proudly helps 2.3 millions unique users a month.It is self-serve and customizable, a complete out-of-the-box experience. It is adaptable to any software, like Stripe, React, and jQuery. Instead of guessing or leafing through pages, your users will leaf through instant search results. It also captures analytics that are key to understanding what your users do and need. You are now data driven to produce great documentation. 

But DocSearch also raises the bar of modern documentation, it standardizes a well-structured approach to documentation. It does this with its crawling mechanism, which its uses to add search to your website. Crawling documentation requires content to follow a certain structure. 

We also improved DocSearch over time. In searching and structuring content, we encountered some fundamental and eternal developer-issues. The biggest one being to choose between space or tabs to indent a page. This was the only negative feedback we had when we integrated DocSearch to jQuery. But we solved this issue, thank to a simple PR:

Why is Ctrl-F Not Enough?

Why go that far with DocSearch when people can just as easily use Ctrl-F? There are many reasons for this:

  • You’ll search the entire documentation site instead of only one downloaded page.
  • Learn-as-you-type experience. Instant search results and a categorized dropdown box enable users to not only search but browse, discover, and learn. We have noticed that people rephrase, correct, and erase their initial search due to what they learned during the search.
  • Speed. In moving from page to page and quickly finding what you need. Millisecond matters.
  • Typo tolerance. Our search corrects wrong queries and mistypes. This is key when you search for unknown concepts or technology
  • Tie-breaking algorithm. This unique concept of Algolia helps the maintainer better redirect their users, helping their users in an interactive way. Less need for support!
  • Analytics. Our search helps you understand what your users are doing. 

Let’s See How it Works

We crawl our 1600+ DocSearch websites every 24H to keep the search synchronized with their content. This process requires a strong and secure infrastructure. We use an infrastructure that scales since we are only at the beginning of the road. This where Kubernetes steps in. Kubernetes (K8s) is an open-source system for automating deployment, scaling, and managing containerized applications. It is now the basis of DocSearch’s daily crawls of over 1600+ documentation websites. If you want more details regarding the architecture chosen, please ping us 🙂

All this comes with a cost. For sure, this project requires a strong and reliable codebase. It all started during a vacation/off site in Porto, Portugal. This is a classic story that we will explain in another blog. Like every project, time is key. We have one main motto on our team: automation! We’ve even built a complete tool that gathers public data about projects in order to provide the best customized help. This too makes for a good blog, which is on its way. To automate properly, we needed to refactor every piece of our tooling. This point is key and helped us ship out our search experience quicker, stronger, and further. 

DX matters even in how we deliver it. We help every compliant project that reaches out to us. However, we’ve noticed that the best way to help big projects is to reach out ourselves. We are hiring to help us with that. Future users of DocSearch only need to click on the “merge” button to see the learn-as-you-type experience alive and in action.

Next Steps for DX

The stable state of our project encourages us to go even further. We always want to show the huge love we have for the community. The road will be long and amazing. We are looking forward to it and we have defined some future additions to DocSearch.

  • Better analytics.
  • A new version (v3) of the UI.
  • Real-time: only crawl website when triggered (that is, when content has changed).
  • Dashboard: Let our users create their own configuration thanks to a UI dashboard.
  • Improve and make our DocSearch Hub public.

Happy coding and writing great documentation!

About the author
Sylvain Pace

DocSearch, Full stack engineer

Start building for free

Create a full-featured search experience in no time.

Get started
Start building for free

Recommended Articles

Powered byAlgolia Algolia Recommend

Algolia DocSearch is now free for all docs sites
product

Shane Afsar

Senior Engineering Manager

Good API Documentation Is Not About Choosing the Right Tool
engineering

Maxime Locqueville

DX Engineering Manager

API Documentation 2.0: From Browsing to Search
product

Peter Villani

Sr. Tech & Business Writer