All Collections
Getting started with HelpBar
Getting started with HelpBar

Learn how to get HelpBar onto your app and configure it to help users out

Tiago Mota avatar
Written by Tiago Mota
Updated over a week ago

You can add the HelpBar to your product today to smooth out users' experience and allow them to deepen their knowledge at their own pace. Here's how to set up your HelpBar to guarantee better product adoption.

Check out a demo of the HelpBar configuration ๐Ÿ”Ž

To use HelpBar in your product, all you have to do is install Chameleon onto your app to leverage Chameleon's functionality. There are several methods you can pick from the Dashboard and once you do, you'll be all set to leverage the HelpBar.

โš™๏ธ If you install Chameleon via JavaScript you'll be able to leverage HelpBar's ability to navigate without a page refresh. This is included in the code snippet you get from the Dashboard (the block of code that includes the Chameleon functionalities), and you'll just have to configure it to fit your app.

There are different types of content you can add to your HelpBar to enable users better on their journey. From the Dashboard, you can add your knowledge base, product navigation, or any individual URL to your HelpBar.

โœจ Leverage our AI assistant to answer users' questions directly in your HelpBar.

Aside from general help resources that everyone can benefit from, you can also leverage your app content that is user or company-specific. Send your data to Chameleon (user properties, events) to create a Segment in Chameleon for your HelpBar.

With any resource you add to your HelpBar, you can pick a specific audience (between Companies and Segments) so your content stays relevant to users.

๐Ÿ‘‰ Learn more about sending data to Chameleon and what properties you can leverage from our User Data Overview.

Depending on your Chameleon plan you can target your HelpBar results to one or more users, companies, or Segments. Here are some targeting limits to keep in mind while you start implementing HelpBar:

  • A Free/Startup account is limited to 10 per SearchItem and in aggregate across all SearchItems.

  • A Growth/Enterprise account is limited to 30 per SearchItem and in aggregate across all SearchItems.

Aside from this, you can also target your content groups (e.g. Help docs, Blog) to one or several companies or Segments.

  • A Free/Startup account is limited to 10 in use across all SearchGroups and in aggregate across all SearchGroups.

  • A Growth/Enterprise account is limited to 30 in use across all SearchGroups and in aggregate across all SearchGroups.

If your plan allows more than 1 HelpBar, each one can have several content groups and each can be targeted to one or more Segments.

  • A Free/Startup account is limited to 20 SearchGroups.

  • A Growth/Enterprise account is limited to 100 SearchGroups.

To ensure you've configured your HelpBar correctly, you can test it out before publishing it live in your product. There are a few ways you can test your HelpBar's content:

โ—พ๏ธ Preview from the Dashboard - the easiest way to see how HelpBar displays for end-users is to preview it from your Dashboard. Once you add content to HelpBar you can use the Preview button to test your search results, any Actions, as well as review how different "Page Collections" display to end-users.

โ—พ๏ธ Publish it to your testing Environment -- you can first publish your HelpBar on your staging domains to test out how it works before publishing it to your production domains.

โ—พ๏ธ Be the user -- once you publish the HelpBar and it's live in your app, you'll have a decent time window to test it out further before users get a chance to use it. If you spot something that's not working as expected, you can unpublish it and review your configuration before users get to experience it live in your product.

๐Ÿ‘‰ For public searchable content, you can also perform a Bing search, in parallel with the HelpBar to see how your documentation shows up. The results and the order that you get in both places should match, or the difference should be subtle.

Does HelpBar work with mobile frameworks?

Chameleon operates in web environments and will work within Cordova, or Electron apps as long as your app resembles a web environment.

Can I control its styling?

Yes, you can style your HelpBar to fit natively into your app (including using Custom CSS) and use custom icons.

Can I add custom content to HelpBar?

Yes, you can add content that is specific to your product or users. See this guide on adding user-generated content via our API.

Did this answer your question?