GITBOOK-113: No subject

docs/SUMMARY.md

@@ -62,6 +62,7 @@
 * [Setup Node.js with NVM](developer-guide/setup-node.js-with-nvm.md)
 * [Setting Up Docker for Development and Production](developer-guide/setting-up-docker-for-development-and-production.md)
 * [CLI Command Reference](developer-guide/cli-command-reference.md)
+* [Extensions](developer-guide/extensions.md)
 * [Plugins](developer-guide/integrations/README.md)
   * [Hexabot Plugin Development](developer-guide/integrations/hexabot-plugin-development.md)
   * [Build your First Plugin](developer-guide/integrations/build-your-first-plugin.md)

docs/developer-guide/extensions.md

@@ -0,0 +1,100 @@
+# Extensions
+
+Hexabot supports **extensions**, which are modular pieces of code that add new capabilities, features, or integrations to your Hexabot instance. Extensions allow you to customize and enhance your Conversational AI by adding functionality beyond the default setup. They can be categorized into three main types: Channels, Plugins, and Helpers.
+
+### How to Install an Extension in Hexabot
+
+Hexabot makes it easy to extend its capabilities by installing extensions. Follow this guide to browse, select, and install the extensions you need.
+
+#### Steps to Install an Extension
+
+1. **Visit the Extension Catalog**
+
+Start by visiting [hexabot.ai/extensions](https://hexabot.ai/extensions), where you can explore a wide variety of community-published extensions. Browse through the available channels, plugins, and helpers to find the one that fits your needs.
+
+2. **Set Up Your Project**
+
+If you haven’t already created a Hexabot project, you can do so using the Hexabot CLI:
+
+```bash
+hexabot create myproject
+cd myproject/
+```
+
+This will generate the base structure for your chatbot project.
+
+3. **Install the Extension**
+
+Extensions are published as NPM packages. To install an extension, run the following command in your project directory:
+
+```bash
+npm i --save hexabot-[channel|plugin|helper]-NAME
+```
+
+• Replace `[channel|plugin|helper]` with the appropriate type of extension.
+
+• Replace NAME with the specific name of the extension you want to install.
+
+For example, to install a plugin for integrating with an external API, the command might look like this:
+
+```bash
+npm i --save hexabot-plugin-ollama
+```
+
+4. **Read the Extension’s Documentation**
+
+Each extension comes with its own documentation that provides detailed usage instructions. Make sure to carefully read and follow the instructions to configure and use the extension effectively.
+
+Extensions are published as <mark style="background-color:yellow;">NPM packages</mark>. Some extensions may depend on other extensions to function correctly. For example:
+
+• A plugin may require a specific helper to operate.
+
+• A channel might rely on a helper for authentication or data handling.
+
+When installing an extension, review its documentation to identify any dependencies and install them as needed.
+
+Extensions published on [hexabot.ai/extensions](https://hexabot.ai/extensions) are reviewed by the Hexabot team and community members to ensure quality and functionality. While we strive to maintain high standards, always test extensions in your environment to ensure they meet your requirements.
+
+### Types of Extensions
+
+#### ![](../.gitbook/assets/image.png)Channels&#x20;
+
+A **channel** enables your AI bot to be accessible through various mediums, making it available to interact with users via different platforms or devices. Channels extend the reach of your bot to:
+
+* Chat apps (e.g., Slack, WhatsApp, Telegram)
+* Social media platforms (e.g., Facebook Messenger, Twitter)
+* Websites or web apps (via embedded chat widgets)
+* IoT devices (e.g., voice assistants, smart appliances)
+* Etc.
+
+Essentially, channels allow your agent to communicate in diverse environments, ensuring seamless accessibility for end-users.
+
+#### ![](<../.gitbook/assets/image (1).png>)Plugins
+
+**Plugins** add new features and capabilities directly to the conversational AI system. The primary type of plugin currently available is the "**Block Plugin**", which allows you to introduce custom blocks in the visual editor. These blocks:
+
+* Enable new actions and integrations in conversation flows.
+* Are fully visible to end-users building flows in the visual editor.
+* Expand the creative possibilities of what your AI agent can do.
+
+For example, you can create a custom plugin to integrate your chatbot with an external API or trigger specific workflows.
+
+#### ![](<../.gitbook/assets/image (2).png>)Helpers
+
+**Helpers** are essential services or utilities that operate in the background to support the functionality of plugins. While they are not exposed to end-users building conversation flows, they play a critical role in ensuring plugins work as intended.
+
+For example:
+
+* A plugin for API integration may require a helper to handle communication with a 3rd Party API.
+* A plugin that retrieves data from a database may depend on a helper to manage queries.
+
+Some plugins may require one or more helpers to function. It is crucial to install the necessary helpers for the plugins you plan to use.
+
+### Building Your Own Extensions
+
+Hexabot encourages users to create their own extensions to further customize their chatbot’s functionality. You can share your extensions with the community to help others benefit from your work.
+
+Visit [hexabot.ai/extensions](https://hexabot.ai/extensions) to explore the liibrary of extensions available for installation and reuse.
+
+If you’re a developer, you can contribute to this growing ecosystem by building and publishing your own extensions to the catalog. Extend Hexabot and help shape the future of conversational AI!
+

docs/developer-guide/integrations/README.md

@@ -1,3 +1,7 @@
+---
+icon: cube
+---
+
 # Plugins
 
 Hexabot's extensions system allows you to add new features and custom integrations. The Hexabot [Extension Library](https://hexabot.ai/extensions) offers a growing collection of plugins, channels and helpers built by the community, ready to be installed and used in your own projects. Plugins allow you to add "**Building Blocks**" that you can use within the [Visual Editor](https://docs.hexabot.ai/user-guide/visual-editor) to build your flows. Each time you install or develop a new custom plugin, a new block will appear in the visual editor's left panel under the "**Custom Blocks**" section. These plugins can range from simple utility enhancements to 3rd party integrations with external apps or systems. This page explains how to install and use existing plugins within your Hexabot project, enabling you to enhance your conversational AI with minimal effort.

docs/user-guide/flows.md

@@ -2,7 +2,7 @@
 
 Hexabot's Flows feature allows you to organize your chatbot's conversation flows into different sections, creating dedicated tabs within the Visual Editor. This makes it easier to manage complex chatbots with multiple topics or functionalities.
 
-<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption><p>Manage Flows</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (4).png" alt=""><figcaption><p>Manage Flows</p></figcaption></figure>
 
 **1. Access Flow Management:**
 
@@ -31,4 +31,4 @@ Hexabot will prevent you from deleting a flow if there are still blocks associat
 
 When you open the Visual Editor, you'll see a tab for each flow you've created. Select the flow tab where you want to design your conversation flow. You can easily switch between the flow tabs to organize your conversation flows.
 
-<figure><img src="../.gitbook/assets/image (1) (1) (1).png" alt=""><figcaption><p>Browse Flows in the Visual Editor</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (1) (1) (1) (1).png" alt=""><figcaption><p>Browse Flows in the Visual Editor</p></figcaption></figure>

docs/user-guide/knowledge-base/README.md

@@ -8,4 +8,4 @@ Hexabot's built-in Knowledge Base is where you store and manage all the informat
 2. **Define Fields (Metadata):** For each content type, define the data fields you need. For a "Product" type, you might have "Name," "Description," "Price," "Image URL," etc.
 3. **Populate Content Entries:** Create individual entries within each content type, filling in the data fields. You might have a separate entry for each product in your catalog, each service you offer, or each question in your FAQ section.
 
-<figure><img src="../../.gitbook/assets/image (3).png" alt=""><figcaption><p>Define Content Types in the Knowledge Base</p></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (3) (1).png" alt=""><figcaption><p>Define Content Types in the Knowledge Base</p></figcaption></figure>

docs/user-guide/localization/languages.md

@@ -6,7 +6,7 @@ icon: globe
 
 Once you have added multiple languages, your chatbot will dynamically respond to users based on their language preference. If the end-user’s language is detected, the chatbot will automatically switch to that language. Otherwise, the default language will be used.
 
-<figure><img src="../../.gitbook/assets/image (4).png" alt=""><figcaption><p>Manage Languages</p></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (4) (1).png" alt=""><figcaption><p>Manage Languages</p></figcaption></figure>
 
 ### Adding a Language
 

docs/user-guide/manage-settings/web-channel.md

@@ -1,6 +1,6 @@
 # Web Channel
 
-<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The Web Channel settings in Hexabot allow you to configure how your chatbot integrates into your website. You can control the appearance of the chatbot widget, manage the chatbot's initial greeting message, and more.
 

docs/user-guide/nlu-training.md

@@ -4,7 +4,7 @@ hidden: true
 
 # NLU Training
 
-<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption><p>NLU Training</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (2) (1).png" alt=""><figcaption><p>NLU Training</p></figcaption></figure>
 
 Hexabot leverages Natural Language Understanding (NLU) to understand what your users are saying and respond appropriately. To make sure Hexabot accurately interprets user intent, you need to train its NLU engine to learn from your user's interactions.&#x20;
 

docs/user-guide/subscribers.md

@@ -40,7 +40,7 @@ Click on the "MANAGE LABELS" button next to the subscriber to manage their label
 * **Promotional Messages:** Send targeted promotional messages based on subscriber labels.
 * **Personalized Responses:** Use labels to provide more personalized responses to users based on their interests or behaviors.
 
-<figure><img src="../.gitbook/assets/image (2) (1).png" alt=""><figcaption><p>Target subscribers with a given label</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (2) (1) (1).png" alt=""><figcaption><p>Target subscribers with a given label</p></figcaption></figure>
 
 **Best Practices for Subscriber Management:**
 

docs/user-guide/visual-editor/regular-blocks/README.md

@@ -4,7 +4,7 @@ Regular blocks are the most common building blocks that a user might need when c
 
 {% tabs %}
 {% tab title="Simple Text" %}
-<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 Chatbots receive and react to a significant volume of textual data. Text messages are the primary form of communication between a chatbot and its users. For this purpose, Hexabot provides the **Simple Text block**, prominently featured in the block palette, to facilitate the addition and configuration of straightforward textual conversational paths.
 
@@ -24,7 +24,7 @@ For this reason, Hexabot offers a variety of interaction possibilities and provi
 {% endtab %}
 
 {% tab title="Quick Replies" %}
-<figure><img src="../../../.gitbook/assets/image (2) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (2) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The Quick Replies block in Hexabot allows you to present users with a predefined set of responses in the form of clickable buttons, eliminating the need for them to manually type their answers. Quick Reply blocks can be configured with conditional triggers, ensuring they are displayed only when certain conditions within the conversation are met. This adds more dynamic control over how Quick Replies are used in your chatbot.
 
@@ -36,11 +36,11 @@ The Quick Replies block in Hexabot allows you to present users with a predefined
 * **Gathering Basic Information:** Use Quick Replies to collect simple user information like language preferences, contact methods, or preferences.
 * **Guiding the Conversation:** Subtly steer the direction of the dialog by suggesting actions or providing prompts as Quick Reply options.
 
-<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td>Using Quick Replies Block Guide</td><td></td><td><a href="../../../.gitbook/assets/image (2) (1) (1).png">image (2) (1) (1).png</a></td><td><a href="using-quick-replies-block.md">using-quick-replies-block.md</a></td></tr></tbody></table>
+<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td>Using Quick Replies Block Guide</td><td></td><td><a href="../../../.gitbook/assets/image (2) (1) (1) (1).png">image (2) (1) (1) (1).png</a></td><td><a href="using-quick-replies-block.md">using-quick-replies-block.md</a></td></tr></tbody></table>
 {% endtab %}
 
 {% tab title="Buttons" %}
-<figure><img src="../../../.gitbook/assets/image (3) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (3) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The **Buttons block** in Hexabot provides a structured and versatile way to present users with interactive choices within your chatbot conversations. It allows you to display a set of clickable buttons, each representing a distinct action or navigation path. Buttons differ from Quick Replies in their visual layout; while Quick Replies typically appear horizontally, Buttons are usually arranged vertically, making them suitable for presenting a more defined list of options.
 
@@ -54,7 +54,7 @@ Buttons blocks, like Quick Replies, can be configured with conditional triggers,
 {% endtab %}
 
 {% tab title="Attachment" %}
-<figure><img src="../../../.gitbook/assets/image (4) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (4) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The **Attachment block** in Hexabot enables you to share files directly within your chatbot conversations, enhancing the user experience with rich media content. Go beyond text-only interactions by sending documents, images, videos, or other relevant files to provide more comprehensive information or a more engaging chatbot experience.
 

docs/user-guide/visual-editor/regular-blocks/using-attachment-block.md

@@ -1,6 +1,6 @@
 # Using Attachment Block
 
-<figure><img src="../../../.gitbook/assets/image (4) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (4) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The Attachment block in Hexabot allows you to share files with your chatbot users, making your conversations more engaging and informative. You can send PDF documents and image, enhancing the chatbot's ability to provide richer and more comprehensive responses.
 

docs/user-guide/visual-editor/regular-blocks/using-buttons-block.md

@@ -1,6 +1,6 @@
 # Using Buttons Block
 
-<figure><img src="../../../.gitbook/assets/image (3) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (3) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The Buttons block enables you to display a set of clickable buttons to users, allowing them to easily make choices and guide the flow of the conversation. Unlike Quick Replies, which are typically displayed horizontally, Buttons can be arranged in a vertical layout, providing a more structured and visually appealing way to present options.
 

docs/user-guide/visual-editor/regular-blocks/using-quick-replies-block.md

@@ -1,6 +1,6 @@
 # Using Quick Replies Block
 
-<figure><img src="../../../.gitbook/assets/image (2) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (2) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The Quick Replies block enhances chatbot interactions by offering users a quick and pratical way to the user to provide a standard input. Instead of typing a response, users can select from a predefined set of buttons, each representing a specific option or action.&#x20;
 

docs/user-guide/visual-editor/regular-blocks/using-simple-text-block.md

@@ -1,6 +1,6 @@
 # Using Simple Text Block
 
-<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>