diff --git a/docs/developer-guide/cli-command-reference.md b/docs/developer-guide/cli-command-reference.md index 6a9de8d2..17efc507 100644 --- a/docs/developer-guide/cli-command-reference.md +++ b/docs/developer-guide/cli-command-reference.md @@ -1,3 +1,7 @@ +--- +icon: rectangle-terminal +--- + # CLI Command Reference Hexabot CLI is a powerful command-line tool to help manage your Hexabot chatbot instance. With it, you can create new projects, initialize environments, start services in various modes, run database migrations, and more. The CLI aims to make managing your chatbot seamless and intuitive. diff --git a/docs/developer-guide/contributers-installation-guide.md b/docs/developer-guide/contributers-installation-guide.md index 35734f14..04505947 100644 --- a/docs/developer-guide/contributers-installation-guide.md +++ b/docs/developer-guide/contributers-installation-guide.md @@ -1,3 +1,7 @@ +--- +icon: handshake-angle +--- + # Contributers Installation Guide ## Prerequisites diff --git a/docs/developer-guide/extensions.md b/docs/developer-guide/extensions.md index 9e42b310..a1c4875e 100644 --- a/docs/developer-guide/extensions.md +++ b/docs/developer-guide/extensions.md @@ -1,3 +1,7 @@ +--- +icon: box-open-full +--- + # 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. diff --git a/docs/developer-guide/hexabot-api.md b/docs/developer-guide/hexabot-api.md index e4be368b..925d9c83 100644 --- a/docs/developer-guide/hexabot-api.md +++ b/docs/developer-guide/hexabot-api.md @@ -1,5 +1,6 @@ --- hidden: true +icon: server --- # Hexabot API diff --git a/docs/developer-guide/hexabot-live-chat-widget.md b/docs/developer-guide/hexabot-live-chat-widget.md index e506dd05..b4c64922 100644 --- a/docs/developer-guide/hexabot-live-chat-widget.md +++ b/docs/developer-guide/hexabot-live-chat-widget.md @@ -1,5 +1,6 @@ --- hidden: true +icon: message --- # Hexabot Live Chat Widget diff --git a/docs/developer-guide/hexabot-nlu-engine.md b/docs/developer-guide/hexabot-nlu-engine.md index 93089a4f..ef7dd6d3 100644 --- a/docs/developer-guide/hexabot-nlu-engine.md +++ b/docs/developer-guide/hexabot-nlu-engine.md @@ -1,5 +1,6 @@ --- hidden: true +icon: brain-circuit --- # Hexabot NLU Engine diff --git a/docs/developer-guide/hexabot-ui-admin-panel.md b/docs/developer-guide/hexabot-ui-admin-panel.md index 589ced6e..312e8003 100644 --- a/docs/developer-guide/hexabot-ui-admin-panel.md +++ b/docs/developer-guide/hexabot-ui-admin-panel.md @@ -1,5 +1,6 @@ --- hidden: true +icon: browser --- # Hexabot UI Admin Panel diff --git a/docs/developer-guide/integrations/README.md b/docs/developer-guide/integrations/README.md index 434ebb74..296feb88 100644 --- a/docs/developer-guide/integrations/README.md +++ b/docs/developer-guide/integrations/README.md @@ -1,5 +1,5 @@ --- -icon: cube +icon: puzzle-piece --- # Plugins diff --git a/docs/developer-guide/setting-up-docker-for-development-and-production.md b/docs/developer-guide/setting-up-docker-for-development-and-production.md index 96d730f1..6f145986 100644 --- a/docs/developer-guide/setting-up-docker-for-development-and-production.md +++ b/docs/developer-guide/setting-up-docker-for-development-and-production.md @@ -1,3 +1,7 @@ +--- +icon: docker +--- + # Setting Up Docker for Development and Production Hexabot uses Docker for development purposes as well as streamline deployment, running essential services like the API, frontend, and MongoDB in containers. The provided Docker Compose setup ensures quick and consistent startup, eliminating manual configuration complexities. diff --git a/docs/developer-guide/setup-node.js-with-nvm.md b/docs/developer-guide/setup-node.js-with-nvm.md index f753d5e8..2ae81f98 100644 --- a/docs/developer-guide/setup-node.js-with-nvm.md +++ b/docs/developer-guide/setup-node.js-with-nvm.md @@ -1,3 +1,7 @@ +--- +icon: node +--- + # Setup Node.js with NVM Node.js is a pre-requisite to run both the Hexabot CLI and a Hexabot project since the API is built on NestJS. Using [NVM](https://github.com/nvm-sh/nvm) (Node Version Manager) simplifies managing the required Node.js version. When creating a new Hexabot project, the structure includes source folders like **extensions** to add custom plugins, helpers and channels, making Node.js essential tool for smooth development and customization. diff --git a/docs/developer-guide/smtp-configuration-and-emails.md b/docs/developer-guide/smtp-configuration-and-emails.md index 7f97d785..e9f9af0f 100644 --- a/docs/developer-guide/smtp-configuration-and-emails.md +++ b/docs/developer-guide/smtp-configuration-and-emails.md @@ -1,3 +1,7 @@ +--- +icon: envelope +--- + # SMTP Configuration and Emails {% hint style="info" %} @@ -11,7 +15,7 @@ You have two options for handling email functionality during development: 1. **Without SMTP**:\ You can run the app without using SMTP by setting the environment variable `EMAIL_SMTP_ENABLED=false`. Simply run `hexabot start` and invite a new user. The app will behave as though it is sending emails, but nothing will happen in the background. 2. **Using smtp4dev for Testing**:\ - We use `smtp4dev` for email testing in the development environment. To use this service, set the `EMAIL_SMTP_ENABLED` to `true` in the `.env` file and restart the app. Then, invite a new user or reset a password and check whether emails are received in the smtp4dev UI interface at [http://localhost:9002/](http://localhost:9002/). This also applies to other scenarios like the confirmation email after signup and the password reset email. + We use `smtp4dev` for email testing in the development environment. To use this service, set the `EMAIL_SMTP_ENABLED` to `true` in the `.env` file and restart the app using the command `hexabot start --services smtp4dev`. Then, invite a new user or reset a password and check whether emails are received in the smtp4dev UI interface at [http://localhost:9002/](http://localhost:9002/). This also applies to other scenarios like the confirmation email after signup and the password reset email. **SMTP Config (Local Dev)** diff --git a/docs/faq/how-can-i-add-the-chatbot-widget-to-my-website.md b/docs/faq/how-can-i-add-the-chatbot-widget-to-my-website.md index 0ecce423..538524f4 100644 --- a/docs/faq/how-can-i-add-the-chatbot-widget-to-my-website.md +++ b/docs/faq/how-can-i-add-the-chatbot-widget-to-my-website.md @@ -1,3 +1,7 @@ +--- +icon: comment-dots +--- + # How can I add the Chatbot Widget to my Website? The [Hexabot](https://hexabot.ai/) Live Chat Widget is a React-based embeddable widget that allows you to integrate real-time chat functionality into your website. This guide will walk you through how to add the widget to your website, customize it to fit your needs, and manage its settings. diff --git a/docs/faq/how-can-i-deploy-my-hexabot-using-nginx.md b/docs/faq/how-can-i-deploy-my-hexabot-using-nginx.md index 4c6f720c..cbe30215 100644 --- a/docs/faq/how-can-i-deploy-my-hexabot-using-nginx.md +++ b/docs/faq/how-can-i-deploy-my-hexabot-using-nginx.md @@ -1,3 +1,7 @@ +--- +icon: arrow-up-from-square +--- + # How can I deploy my Hexabot using NGINX ? ### Introduction diff --git a/docs/user-guide/analytics-dashboard.md b/docs/user-guide/analytics-dashboard.md index 34c17805..e3cff98d 100644 --- a/docs/user-guide/analytics-dashboard.md +++ b/docs/user-guide/analytics-dashboard.md @@ -1,3 +1,7 @@ +--- +icon: chart-line +--- + # Analytics Dashboard {% hint style="info" %} diff --git a/docs/user-guide/chat-inbox.md b/docs/user-guide/chat-inbox.md index e50c2e44..7d12d141 100644 --- a/docs/user-guide/chat-inbox.md +++ b/docs/user-guide/chat-inbox.md @@ -1,3 +1,7 @@ +--- +icon: inbox-full +--- + # Chat Inbox The Chat Inbox in Hexabot is your central hub for monitoring all conversations between your chatbot and users. This comprehensive view allows you to track interactions, review past conversations, and intervene in real-time when necessary. diff --git a/docs/user-guide/context-variables.md b/docs/user-guide/context-variables.md index a4d263c4..8678c21f 100644 --- a/docs/user-guide/context-variables.md +++ b/docs/user-guide/context-variables.md @@ -1,3 +1,7 @@ +--- +icon: brackets-curly +--- + # Context Variables

Manage Context Variables

diff --git a/docs/user-guide/flows.md b/docs/user-guide/flows.md index 8aab73db..2cc2af7c 100644 --- a/docs/user-guide/flows.md +++ b/docs/user-guide/flows.md @@ -1,3 +1,7 @@ +--- +icon: diagram-project +--- + # Flows 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. diff --git a/docs/user-guide/knowledge-base/README.md b/docs/user-guide/knowledge-base/README.md index f8b6e75d..5705d26d 100644 --- a/docs/user-guide/knowledge-base/README.md +++ b/docs/user-guide/knowledge-base/README.md @@ -1,3 +1,7 @@ +--- +icon: books +--- + # Knowledge Base Hexabot's built-in Knowledge Base is where you store and manage all the information your chatbot uses to interact with users. Think of it as a centralized knowledge base that keeps all your chatbot's responses accurate, consistent, and up-to-date. diff --git a/docs/user-guide/localization/README.md b/docs/user-guide/localization/README.md index 62774ae0..93635c20 100644 --- a/docs/user-guide/localization/README.md +++ b/docs/user-guide/localization/README.md @@ -1,3 +1,7 @@ +--- +icon: language +--- + # Localization Hexabot's chatbot builder allows you to create multilingual chatbots by managing languages within the platform. This feature enables you to define the languages your chatbot will support and handle translations for blocks, messages, quick replies, buttons, and more. diff --git a/docs/user-guide/manage-settings/README.md b/docs/user-guide/manage-settings/README.md index 4582f13b..b46cac86 100644 --- a/docs/user-guide/manage-settings/README.md +++ b/docs/user-guide/manage-settings/README.md @@ -1,3 +1,7 @@ +--- +icon: gear +--- + # Manage Settings This guide will walk you through the various settings available within the Hexabot platform, empowering you to tailor your chatbot's behavior, appearance, and integrations to suit your specific needs and goals. diff --git a/docs/user-guide/nlu/README.md b/docs/user-guide/nlu/README.md index 8b641489..8d4b5e04 100644 --- a/docs/user-guide/nlu/README.md +++ b/docs/user-guide/nlu/README.md @@ -1,3 +1,7 @@ +--- +icon: brain-circuit +--- + # NLU ### What is NLU? diff --git a/docs/user-guide/subscribers.md b/docs/user-guide/subscribers.md index 280c7d58..85e93163 100644 --- a/docs/user-guide/subscribers.md +++ b/docs/user-guide/subscribers.md @@ -1,3 +1,7 @@ +--- +icon: users-between-lines +--- + # Subscribers In Hexabot, we define a subscriber as then end-user who will ultimately interact with the chatbot. The Subscriber Management features allow you to effectively track, organize, and interact with the users who engage with your chatbot. This guide will walk you through the process of managing your subscriber base, segmenting them using labels, and leveraging subscriber data for improved communication and targeted interactions. diff --git a/docs/user-guide/users-and-roles/README.md b/docs/user-guide/users-and-roles/README.md index 23fa60c0..4ce9b3e5 100644 --- a/docs/user-guide/users-and-roles/README.md +++ b/docs/user-guide/users-and-roles/README.md @@ -1,4 +1,8 @@ -# Manage User and Roles +--- +icon: users-gear +--- + +# Users and Roles Hexabot offers robust user and role management features to streamline collaboration and ensure security within your chatbot projects. Whether you're working with a team of developers, content creators, or marketing professionals, Hexabot makes it easy to grant the right access levels to the right people. diff --git a/docs/user-guide/visual-editor/README.md b/docs/user-guide/visual-editor/README.md index 58456dd6..7e7707cd 100644 --- a/docs/user-guide/visual-editor/README.md +++ b/docs/user-guide/visual-editor/README.md @@ -1,3 +1,7 @@ +--- +icon: table-columns +--- + # Visual Editor