Open Help Docs From Your App

You can enhance user support and guidance within your app by providing access to help documents. The @beacon.li/bar package allows you to open help documents programmatically, making it easy for users to find information and answers to their questions.

Opening a Help Document

To open a help document from your app, you can use the Beacon.openHelpDoc method. This method takes two parameters:

1. helpDocId (string): The unique identifier of the help document you want to open.

2. type (string, optional, default: 'default'): The type of the help document, which can be 'default' or 'max'.

Here's how to use it:

import { Beacon } from '@beacon.li/bar';
Beacon.openHelpDoc('helpDocId', 'default');

In the example above, we are opening a help document with the ID 'helpDocId' and specifying it as a 'default' view document. This will display the content of the help document in a default view, if you replace it with 'max' string it will show the document in a maximum view.

Help Document Types

• Default: A document with a 'default' view type will be presented to the user in a standard format i.e as a chat-size-window in the bottom right corner.

• Max: A document with a 'max' view type will be displayed to the user in a view that maximizes its visibility or content presentation i.e full-viewport-height size in the bottom right corner. This view offers better readability if the content is too long.

Use Cases

Opening help documents programmatically can be useful for various scenarios, including:

• Providing users with quick access to documentation or FAQs.

• Offering step-by-step tutorials or guides within your app.

• Displaying detailed information on specific app features or functionalities.

By incorporating help document opening functionality using @beacon.li/bar, you can improve user engagement and ensure that users have easy access to the information they need.

Important Note

Ensure that you have a clear understanding of the content and purpose of each help document you open programmatically. Make sure that it aligns with your app's support and guidance strategy.

By following these steps, you can open help documents from your app programmatically using the Beacon.openHelpDoc method.