Help Doc

This page tells us how to setup the "Help Docs" tab under the Help Center

Help Docs Tab

The Help Docs tab allows agencies to curate and organize external product documentation in a structured manner for their customers. These documents can include setup instructions, troubleshooting guides, feature explanations, and other reference materials hosted on third-party sites or on the agency’s own knowledge base.

Each set of documents is grouped under a "Collection", enabling agencies to categorize content by topic or use case. These collections are then made accessible to customers through the Help Center within the dashboard, offering a seamless self-service experience. This helps in reducing support dependency, onboarding time, and repetitive queries by providing reliable and readily available support documentation.

Benefits of the Help Docs

  • Offers centralized access to product-related documentation, improving customer autonomy.

  • Helps reduce repetitive support requests by proactively answering common queries.

  • Enables agencies to tailor documentation visibility and layout to suit their audience.

  • Supports scalable onboarding and product education with minimal operational effort.

How to Setup the Help Docs Tab:

Step 1: Add a Help Docs Collection

  1. Log in to your Agency Panel and navigate to Help Center under the Configurations section.

  2. Click on the Help Docs tab.

  3. Click the Add Collection button to create a new documentation group.

  4. Fill out the following fields:

    • Collection Title – Enter the name for the documentation group (max 80 characters).

    • Collection Description – Write a short summary or description (max 200 characters).

    • Collection Icon (40x40) – Upload an icon that visually represents the collection.

    • Show Cover Image toggle:

      • ON – Allows articles within the collection to show their cover images.

      • OFF – Hides all article images in the collection.

    • Open in New Tab toggle:

      • ON – Article links will open in a new browser tab.

      • OFF – Article opens inside the dashboard (recommended).

  5. Click Add Collection to save the group.

Step 2: Add Articles to the Collection

  1. Click on the name of the collection to open and manage its contents.

  2. Click the Add Article button.

  3. Fill in the following details:

    • Article Title – Title of the article (max 50 characters).

    • Article Link – Provide the full URL for the help article.

    • Article Cover Image (300x180) – Upload a visual thumbnail (required if "Show Cover Image" is ON).

You can add up to 10 articles per collection.

Step 3: Manage and Edit Articles

  • Edit: Click the pen icon next to any article to update the title or link.

  • Delete: Use the trash icon to permanently remove the article.

  • Enable/Disable: Use the toggle switch to control article visibility.

  • Search: Use the search bar to quickly find articles by title.

Step 4: Manage Collections

  • Edit Collection: Use the pen icon to update collection details.

  • Delete Collection: Use the trash icon to remove the collection entirely.

  • Reorder Collections: Use drag-and-drop on the left handle to arrange their display order on the customer-facing Help Center.

Step 5: Publish Your Changes

  • Changes remain as drafts until published.

  • Click the Publish (✓) button on the top-right to make the updated Help Docs live for end users.

FAQ's:

What is the Help Docs tab used for?

The Help Docs tab allows agencies to share external support and documentation resources with their customers in a structured, categorized format. These resources can include tutorials, how-to guides, or knowledge base articles hosted outside the platform.

How many articles can I add in one collection?

You can add up to 10 articles in a single collection.

Can I show images for each article?

Yes, but only if the "Show Cover Image" toggle is enabled while creating the collection. Each article must have a 300x180px image uploaded to be displayed.

What kind of links can I include in the articles?

You can include any valid public URL—such as documentation pages, blog articles, or help desk links. Ensure they are accessible to customers without requiring login.

How do I control whether articles open in the dashboard or a new tab?

You can use the "Open in New Tab" toggle when creating or editing the collection. When turned ON, articles open in a new browser tab. When OFF, articles open within the dashboard view.

Can customers make changes to the Help Docs?

No. Customers only have read-only access. All collections and articles are fully controlled by the agency via the Partner Panel.

PreviousSetup WizardNextUpdates

Last updated

Was this helpful?