Skip to main content
ReadMe integration: user guide

Learn how to set up and use Chameleon's ReadMe integration

Chameleon Team avatar
Written by Chameleon Team
Updated over a week ago

Use our ReadMe integration to connect your knowledge base and enable users to find answers whenever they have questions. Bring your documentation to your product and help users succeed and find more and more value.

Availability & Usage

πŸ§ͺ HelpBar BETA available for all plans

βš™οΈ Enable from the Dashboard

Quick access

The HelpBar is Chameleon's "Spotlight Search" engine that you can add to your product and enable users to learn with a quick search about anything they're looking for. Here's how ours looks when you bring it up. πŸ‘‡

The Chameleon HelpBar

Add different helpful resources to it, such as help or developer docs, but also specific guides or links that enable your users to get the best out of your product. You can choose to have it always-on-display, or launchable at a keyboard command and customize its styling to fit your app.

πŸ‘‰ The HelpBar is available in BETA for all Chameleon plans.

To leverage your ReadMe documentation with the HelpBar, go to the Dashboard to connect your integration first. You'll need to add an API key from your ReadMe account and your Help Center's URL.

Once connected, Chameleon will be able to search your knowledge base content and you can go ahead to further configure the HelpBar on your account.

πŸ‘€ We are currently working to bring the HelpBar configuration to your Dashboard soon. Meanwhile, if you're interested in leveraging your help content with the HelpBar, contact us to enable this for you.

The HelpBar is a powerful tool that you can leverage to connect users with all the helpful resources you're creating to enable them.

Use our ReadMe integration with the HelpBar to allow users to search for help as they use your product, and find the answers with a few clicks. You can create a smoother user experience, with no interruptions but all the well-written documentation available at their fingertips.

πŸ’‘ You can also pin the most useful resources that will show up every time the HelpBar is launched.

Connect more

Did this answer your question?