Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
119 commits
Select commit Hold shift + click to select a range
074b438
GITBOOK-28: No subject
marrouchi Sep 13, 2024
9d04f95
GITBOOK-29: Update quick start cards target link
medchedli Sep 13, 2024
8f2caf2
GITBOOK-30: Update manage users user guide
medchedli Sep 13, 2024
6f24af9
GITBOOK-31: Update manage roles user guide
medchedli Sep 13, 2024
dff04c8
GITBOOK-32: Update Docs Menu
medchedli Sep 13, 2024
07b762d
GITBOOK-33: Remove welcome page cover
medchedli Sep 13, 2024
8a66739
GITBOOK-34: Update settings user guide
medchedli Sep 13, 2024
8bcaa44
GITBOOK-35: No subject
medchedli Sep 13, 2024
dc33b7c
GITBOOK-36: Update the NLP provider settings guide
medchedli Sep 13, 2024
dbd54a1
GITBOOK-37: Update web channel settings page
medchedli Sep 13, 2024
b0e3734
GITBOOK-38: Update the Live Chat Widget settings page
medchedli Sep 13, 2024
6dabf13
GITBOOK-39: Update Context Vars user guide
medchedli Sep 13, 2024
bf94761
GITBOOK-40: Update chat inbox user guide
medchedli Sep 13, 2024
ab22c2c
GITBOOK-41: No subject
medchedli Sep 13, 2024
01c0df9
GITBOOK-42: Update manage categories user guide
medchedli Sep 13, 2024
65f4762
GITBOOK-43: No subject
marrouchi Sep 14, 2024
20058f7
GITBOOK-44: No subject
marrouchi Sep 14, 2024
50ec8c6
GITBOOK-45: No subject
marrouchi Sep 14, 2024
3faff24
GITBOOK-46: No subject
marrouchi Sep 14, 2024
57ddbaf
GITBOOK-48: Update Using Simple Text Block page
medchedli Sep 14, 2024
040122b
GITBOOK-47: No subject
marrouchi Sep 14, 2024
8e7af1e
GITBOOK-50: No subject
medchedli Sep 14, 2024
31ae1a3
GITBOOK-49: No subject
marrouchi Sep 14, 2024
f5d26d0
GITBOOK-51: No subject
marrouchi Sep 14, 2024
512bcc5
GITBOOK-52: No subject
marrouchi Sep 14, 2024
642cd77
GITBOOK-54: No subject
marrouchi Sep 16, 2024
efeb651
GITBOOK-53: Update page title
medchedli Sep 16, 2024
162a2d8
GITBOOK-56: No subject
marrouchi Sep 18, 2024
24e22ff
GITBOOK-57: No subject
marrouchi Sep 18, 2024
349dc32
GITBOOK-58: No subject
marrouchi Sep 18, 2024
62483e7
GITBOOK-59: No subject
marrouchi Sep 20, 2024
4f5a5ca
GITBOOK-60: No subject
marrouchi Sep 20, 2024
a829078
GITBOOK-55: No subject
marrouchi Sep 22, 2024
fd81adb
GITBOOK-61: No subject
marrouchi Sep 22, 2024
c078aad
GITBOOK-62: Update Create your first flow guide
medchedli Sep 26, 2024
6d299c1
GITBOOK-68: No subject
marrouchi Oct 2, 2024
8283d89
GITBOOK-69: No subject
marrouchi Oct 2, 2024
136d189
GITBOOK-70: No subject
marrouchi Oct 2, 2024
4eb8c3d
GITBOOK-71: Replace product presentation image in welcome page
medchedli Oct 2, 2024
d712588
GITBOOK-72: Update broken links
medchedli Oct 2, 2024
0261162
GITBOOK-73: Update create your fist flow quick-start guide
medchedli Oct 4, 2024
da16a36
GITBOOK-74: No subject
marrouchi Oct 5, 2024
021deb8
GITBOOK-75: No subject
marrouchi Oct 5, 2024
34af711
GITBOOK-76: No subject
marrouchi Oct 5, 2024
17881fa
GITBOOK-65: No subject
marrouchi Oct 5, 2024
7c45d4e
GITBOOK-77: No subject
marrouchi Oct 5, 2024
938b108
GITBOOK-78: No subject
marrouchi Oct 5, 2024
80ac407
GITBOOK-79: No subject
marrouchi Oct 5, 2024
59a4c07
GITBOOK-80: No subject
marrouchi Oct 5, 2024
824dc43
GITBOOK-81: No subject
marrouchi Oct 5, 2024
e1f0ddb
GITBOOK-82: No subject
marrouchi Oct 5, 2024
d74229a
GITBOOK-83: No subject
marrouchi Oct 5, 2024
fddf035
GITBOOK-84: No subject
marrouchi Oct 5, 2024
bbb0ae0
GITBOOK-85: No subject
marrouchi Oct 5, 2024
e9690b0
GITBOOK-86: No subject
marrouchi Oct 5, 2024
2a108b9
GITBOOK-87: No subject
marrouchi Oct 5, 2024
e1e611a
GITBOOK-88: No subject
marrouchi Oct 5, 2024
91d8987
GITBOOK-90: No subject
marrouchi Oct 14, 2024
d5e6790
GITBOOK-91: No subject
marrouchi Oct 14, 2024
e3e31f6
GITBOOK-89: Add FAQ pages Group
medchedli Oct 15, 2024
8f70e82
GITBOOK-92: No subject
marrouchi Oct 28, 2024
d3c1764
GITBOOK-93: No subject
marrouchi Oct 28, 2024
597bf96
GITBOOK-94: No subject
marrouchi Nov 12, 2024
a5ad765
GITBOOK-95: abdousfayhi12's Nov 20 changes
marrouchi Nov 20, 2024
a3ca24d
GITBOOK-96: Ikbel's Nov 22 changes
IkbelTalebHssan Nov 22, 2024
d751fdf
GITBOOK-97: Ikbel's Nov 22 changes
IkbelTalebHssan Nov 22, 2024
546bd0d
GITBOOK-98: Update Hexabot API Developer Guide
medchedli Nov 26, 2024
77a4d14
GITBOOK-100: Ikbel's Dec 5 changes
marrouchi Dec 6, 2024
fb82bb4
GITBOOK-102: Add documentation related to the addition of FRONTEND_BA…
medchedli Dec 16, 2024
a4c8eda
GITBOOK-99: Add Hexabot Plugins Development Guide
medchedli Dec 17, 2024
eff83c6
GITBOOK-101: update: block form screenshots
medchedli Dec 17, 2024
1c25297
GITBOOK-103: No subject
marrouchi Dec 17, 2024
1af846f
GITBOOK-104: No subject
marrouchi Dec 17, 2024
bb10eca
GITBOOK-105: No subject
marrouchi Dec 17, 2024
5534096
GITBOOK-109: Fix typo in the Plugin Folder Structure
medchedli Dec 18, 2024
c2d4a40
GITBOOK-108: Update Windows installation instructions
medchedli Dec 18, 2024
133a90c
GITBOOK-110: No subject
marrouchi Dec 18, 2024
a35f4d8
GITBOOK-111: No subject
marrouchi Dec 18, 2024
4d864fc
GITBOOK-112: No subject
marrouchi Dec 18, 2024
df7271a
GITBOOK-113: No subject
marrouchi Dec 19, 2024
ce85982
GITBOOK-116: fix broken link
medchedli Dec 19, 2024
934d401
GITBOOK-117: Update LLM-NLU Engine docs
medchedli Dec 19, 2024
14de5f7
GITBOOK-120: No subject
marrouchi Dec 21, 2024
7f5289c
GITBOOK-121: No subject
marrouchi Dec 21, 2024
f65bc49
GITBOOK-119: Mohamedali's Dec 20 changes
marrouchi Dec 21, 2024
ef523cb
GITBOOK-122: No subject
marrouchi Dec 21, 2024
0b19a94
GITBOOK-123: No subject
marrouchi Dec 22, 2024
51e7ae6
GITBOOK-124: fix broken links
medchedli Dec 22, 2024
060673d
GITBOOK-125: Update broken links in Hexabot deployment guide tuto
medchedli Dec 22, 2024
8d9fb50
GITBOOK-126: Update Ludwig NLU Engine Docs
medchedli Jan 3, 2025
4ea2aac
GITBOOK-127: Mohamedali's Jan 3 changes
MohamedAliBouhaouala Jan 6, 2025
15bdd32
GITBOOK-129: Update SMTP Configuration
medchedli Jan 17, 2025
bd6b8f2
GITBOOK-130: Update outdated command in SMTP setup guide
medchedli Jan 20, 2025
62face2
GITBOOK-128: Update Hexabot NGNIX setup guide
medchedli Jan 20, 2025
7b3b96b
GITBOOK-132: No subject
marrouchi Jan 24, 2025
5aa350d
GITBOOK-133: No subject
marrouchi Jan 24, 2025
e0754db
GITBOOK-134: No subject
marrouchi Jan 29, 2025
595887b
GITBOOK-131: Update Pages Icons
marrouchi Jan 31, 2025
60e05a4
GITBOOK-135: No subject
medchedli Jan 31, 2025
24032b6
GITBOOK-136: No subject
medchedli Jan 31, 2025
d0c416a
GITBOOK-137: No subject
medchedli Feb 3, 2025
c25697f
GITBOOK-118: fix a typo in home page and reorder pages
medchedli Feb 10, 2025
974c486
GITBOOK-138: Add guide for training Ludwig NLU models
medchedli Feb 10, 2025
6664cc0
GITBOOK-141: Fix: Correct NODE_ENV value in deployment guide
medchedli Feb 18, 2025
449faef
GITBOOK-144: Add clarifying comment for EMAIL_SMTP_SECURE
medchedli Sep 3, 2025
26cccb4
GITBOOK-145: Update UI Screenshots - Sep 15 changes
medchedli Sep 16, 2025
b98afd4
GITBOOK-142: Update Ludwig NLU Engine installation guide
medchedli Sep 16, 2025
5d66fc1
GITBOOK-143: Add NLU Match Scoring - May 6 changes
marrouchi Sep 16, 2025
b801789
GITBOOK-147: Repalce features cards cover images with icons
medchedli Sep 16, 2025
d25eb98
GITBOOK-151: No subject
medchedli Sep 16, 2025
0049713
GITBOOK-152: No subject
medchedli Sep 16, 2025
0b047f1
GITBOOK-153: Update Plugin settings screenshot
medchedli Sep 16, 2025
ebe3bf9
GITBOOK-154: multiple docs fix and updates
medchedli Sep 17, 2025
2f8613d
GITBOOK-150: Add prerequisites section for the "Create your first flo…
medchedli Sep 17, 2025
0ec13cd
GITBOOK-149: Add docs for bulk Import of NLU Entities and Values
medchedli Sep 17, 2025
adcd387
GITBOOK-148: Add Pattern Entities docs
medchedli Sep 17, 2025
3375edc
GITBOOK-155: No subject
medchedli Sep 17, 2025
c53580b
GITBOOK-156: fix taxonomy inconsistency and broken links
medchedli Sep 17, 2025
ff1ede0
GITBOOK-157: delete obsolete pages
medchedli Sep 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/.gitbook/assets/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - Channels-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - Channels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - Flow (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - Flow (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - Flow-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - Flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - GenAi (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - GenAi (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - GenAi(1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - GenAi(2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - GenAi-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Cards Cover - GenAi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/Mockup 01.png
Binary file added docs/.gitbook/assets/Untitled.png
Binary file added docs/.gitbook/assets/image (1) (1) (1) (1).png
Binary file added docs/.gitbook/assets/image (1) (1) (1).png
Binary file added docs/.gitbook/assets/image (1) (1).png
Binary file added docs/.gitbook/assets/image (1).png
Binary file added docs/.gitbook/assets/image (10).png
Binary file added docs/.gitbook/assets/image (11).png
Binary file added docs/.gitbook/assets/image (12).png
Binary file added docs/.gitbook/assets/image (13).png
Binary file added docs/.gitbook/assets/image (14).png
Binary file added docs/.gitbook/assets/image (15).png
Binary file added docs/.gitbook/assets/image (16).png
Binary file added docs/.gitbook/assets/image (17).png
Binary file added docs/.gitbook/assets/image (18).png
Binary file added docs/.gitbook/assets/image (19).png
Binary file added docs/.gitbook/assets/image (2) (1) (1) (1).png
Binary file added docs/.gitbook/assets/image (2) (1) (1).png
Binary file added docs/.gitbook/assets/image (2) (1).png
Binary file added docs/.gitbook/assets/image (2).png
Binary file added docs/.gitbook/assets/image (20).png
Binary file added docs/.gitbook/assets/image (21).png
Binary file added docs/.gitbook/assets/image (22).png
Binary file added docs/.gitbook/assets/image (23).png
Binary file added docs/.gitbook/assets/image (24).png
Binary file added docs/.gitbook/assets/image (25).png
Binary file added docs/.gitbook/assets/image (26).png
Binary file added docs/.gitbook/assets/image (27).png
Binary file added docs/.gitbook/assets/image (28).png
Binary file added docs/.gitbook/assets/image (29).png
Binary file added docs/.gitbook/assets/image (3) (1) (1).png
Binary file added docs/.gitbook/assets/image (3) (1).png
Binary file added docs/.gitbook/assets/image (3).png
Binary file added docs/.gitbook/assets/image (30).png
Binary file added docs/.gitbook/assets/image (31).png
Binary file added docs/.gitbook/assets/image (32).png
Binary file added docs/.gitbook/assets/image (33).png
Binary file added docs/.gitbook/assets/image (34).png
Binary file added docs/.gitbook/assets/image (35).png
Binary file added docs/.gitbook/assets/image (36).png
Binary file added docs/.gitbook/assets/image (37).png
Binary file added docs/.gitbook/assets/image (38).png
Binary file added docs/.gitbook/assets/image (39).png
Binary file added docs/.gitbook/assets/image (4) (1) (1).png
Binary file added docs/.gitbook/assets/image (4) (1).png
Binary file added docs/.gitbook/assets/image (4).png
Binary file added docs/.gitbook/assets/image (5).png
Binary file added docs/.gitbook/assets/image (6).png
Binary file added docs/.gitbook/assets/image (7).png
Binary file added docs/.gitbook/assets/image (8).png
Binary file added docs/.gitbook/assets/image (9).png
Binary file added docs/.gitbook/assets/image.png
Binary file added docs/.gitbook/assets/mediamodifier_image.png
Binary file added docs/.gitbook/assets/time-Plugin-settings.jpg
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/add-edit-keyword-entity-form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Add/Edit Keyword Entity Form
---

<figure><img src="../assets/image (38).png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/add-edit-nlu-trait-value-form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Add/Edit NLU Trait Value Form
---

<figure><img src="../assets/image (39).png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/add-edit-pattern-entity-form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Add/Edit Pattern Entity Form
---

<figure><img src="../assets/Screenshot 2025-09-16 at 15-55-06 Hexabot.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/add-new-content-type-form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Add New Content Type Form
---

<figure><img src="../assets/image (35).png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/attachement-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Attachement Block
---

<figure><img src="../assets/Screenshot 2025-09-15 at 16-47-12 Hexabot.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/buttons-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Buttons Block
---

<figure><img src="../assets/Screenshot 2025-09-15 at 16-46-02 Hexabot.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/list-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: List Block
---

<figure><img src="../assets/Screenshot 2025-09-15 at 16-48-45 Hexabot.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/nlu-samples-tab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: NLU Samples Tab
---

<figure><img src="../assets/image (37).png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/quick-replies-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Quick Replies Block
---

<figure><img src="../assets/Screenshot 2025-09-15 at 16-44-44 Hexabot.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/simle-text-block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Simle Text Block
---

<figure><img src="../assets/Screenshot 2025-09-15 at 16-42-40 Hexabot.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/time-plugin-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Time Plugin Settings
---

<figure><img src="../assets/time-Plugin-settings.jpg" alt=""><figcaption></figcaption></figure>
7 changes: 7 additions & 0 deletions docs/.gitbook/includes/untitled (1).md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Untitled
---

{% content-ref url="../../developer-guide/setup-node.js-with-nvm.md" %}
[setup-node.js-with-nvm.md](../../developer-guide/setup-node.js-with-nvm.md)
{% endcontent-ref %}
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/untitled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Setup Node.js with NVM
---

<figure><img src="../assets/image.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/visual-editor-screenshot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Visual Editor Screenshot
---

<figure><img src="../assets/bb20d6a1-cfd5-48ca-a3a9-da27bcf521be.png" alt=""><figcaption><p>Browse Flows in the Visual Editor</p></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/visual-editor-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Visual Editor UI
---

<figure><img src="../assets/Dark.png" alt=""><figcaption></figcaption></figure>
5 changes: 5 additions & 0 deletions docs/.gitbook/includes/visuel-editor-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Visuel Editor UI
---

<figure><img src="../assets/Dark.png" alt=""><figcaption><p>A preview of Hexabot visual editor</p></figcaption></figure>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Visuel Editor with Simple Text Block
---

<figure><img src="../assets/1f0a335a-af75-4fab-8ee9-ce54d9e22a8d.png" alt=""><figcaption></figcaption></figure>
47 changes: 47 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
icon: house-window
---

# Welcome

Welcome to the Hexabot Documentation! Hexabot is a powerful and versatile open-source chatbot platform designed to simplify the creation and management of intelligent conversational chatbots. Whether you're a business owner seeking to automate customer interactions, an organization looking to engage your audience, or a developer wanting to integrate conversational AI into your applications, Hexabot provides the tools and flexibility you need.

{% include ".gitbook/includes/visuel-editor-ui.md" %}

## Key Features

Hexabot comes equipped with a comprehensive suite of features to empower your chatbot development:

* **Intuitive Visual Editor:** Build complex conversation flows without coding using our drag-and-drop interface and a diverse library of pre-built blocks.
* **NLU Engine:** Leverage state-of-the-art NLU technology to understand user intent, extract key information, and deliver personalized responses.
* **Flexible Deployment Options:** Deploy your chatbots on various platforms, including Facebook Messenger, web widgets, and custom integrations.
* **Comprehensive Analytics and Reporting:** Track key metrics, monitor chatbot performance, and gain valuable insights into user interactions.
* **And More:** Discover a range of additional features, including user segmentation, content management, and third-party integrations.

## Who Should Use This Documentation

This documentation is a valuable resource for:

* **New Users:** Get started with Hexabot, learn the basics of chatbot creation, and build your first conversational chatbot.
* **Experienced Users**: Explore advanced features, optimize your existing chatbots, and discover best practices for chatbot development.
* **Developers**: Integrate Hexabot with your applications, leverage our APIs, and extend the platform's functionality by developing add-ons for Hexabot.
* **Administrators**: Manage users, configure settings, and ensure the smooth operation of Hexabot within your organization.

## How to Use This Documentation

To navigate this documentation effectively:

* **Search**: Use the search bar to quickly find information on specific topics or keywords.
* **Navigation**: Browse through the table of contents to explore different sections and find the information you need.
* **Links**: Follow links to related articles and resources for in-depth explanations and examples.

Feedback: We encourage you to provide feedback and suggestions for improvement. Your input helps us make this documentation even better.&#x20;

## Contacting Support

If you encounter any issues or have questions not addressed in this documentation, our dedicated support team is here to assist you. Please contact us at [[email protected]](mailto:[email protected])

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Install Hexabot and create your first flow</td><td><a href=".gitbook/assets/1.png">1.png</a></td><td></td><td><a href="quickstart/installation.md">installation.md</a></td></tr><tr><td><strong>Product overview</strong></td><td>Key Features and Capabilities</td><td><a href=".gitbook/assets/4.png">4.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>User Guide</strong></td><td>Learn the basics of Hexabot</td><td><a href=".gitbook/assets/2.png">2.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Developer Guide</strong></td><td>Learn how to develop for Hexabot</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Key Concepts</strong></td><td>Understanding the Fundamentals of Chatbot Building</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Automate link validation for docs.

Add a quick link-check to CI to prevent regressions.


🏁 Script executed:

#!/bin/bash
# Validate internal Markdown links and referenced assets.
set -euo pipefail

# 1) Find placeholder/broken references
rg -n 'broken-reference' docs || true

# 2) List all markdown links and verify targets exist (internal only)
rg -nPo '\[[^\]]+\]\((?!http)(?!mailto:)([^)]+)\)' docs \
  | awk -F'(' '{print $1"\t" $2}' | sed 's/)$//' \
  | while IFS=$'\t' read -r loc target; do
      # Strip anchors
      path="${target%%#*}"
      # Normalize leading ./ if any
      path="${path#./}"
      if [ -n "$path" ] && [ ! -e "docs/$path" ] && [ ! -e "$path" ]; then
        echo "Missing target: $target (from $loc)"
      fi
    done

# 3) Verify referenced assets exist
rg -nPo '\((\.gitbook/assets/[^)]+)\)|src="(\.gitbook/assets/[^"]+)"' docs | sed -E 's/.*(\/\.gitbook\/assets\/[^")]+).*/\1/' \
  | while read -r asset; do
      [ -e "$asset" ] || echo "Missing asset: $asset"
    done

Length of output: 35620


Fix broken documentation links and add CI link-validation step.

  • Resolve all current broken references and missing assets reported (e.g. occurrences of broken-reference) before merging.
  • Integrate the provided Markdown-link check script into CI to catch future regressions.
🤖 Prompt for AI Agents
In docs/README.md around line 57, the table contains multiple "broken-reference"
links and possibly missing asset references; update each broken link to the
correct relative paths (e.g., point to quickstart/installation.md and valid docs
pages or remove rows if obsolete) and ensure referenced assets
(.gitbook/assets/*.png) exist in the repo or are replaced with valid images;
additionally add the provided Markdown link-check script into the CI workflow
(e.g., run the script as a step in your existing CI job) so link validation runs
on PRs to prevent future regressions.

⚠️ Potential issue

Replace “Broken link” placeholders with real targets.

Broken links on the homepage harm navigation.

-...<td><a href="broken-reference">Broken link</a></td>...
+...<td><a href="introduction/overview.md">introduction/overview.md</a></td>...
...
-...<td><a href="broken-reference">Broken link</a></td>...
+...<td><a href="user-guide/README.md">user-guide/README.md</a></td>...
...
-...<td><a href="broken-reference">Broken link</a></td>...
+...<td><a href="developer-guide/README.md">developer-guide/README.md</a></td>...
...
-...<td><a href="broken-reference">Broken link</a></td>...
+...<td><a href="key-concepts/README.md">key-concepts/README.md</a></td>...

If these exact targets differ in your repo, adjust accordingly.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Install Hexabot and create your first flow</td><td><a href=".gitbook/assets/1.png">1.png</a></td><td></td><td><a href="quickstart/installation.md">installation.md</a></td></tr><tr><td><strong>Product overview</strong></td><td>Key Features and Capabilities</td><td><a href=".gitbook/assets/4.png">4.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>User Guide</strong></td><td>Learn the basics of Hexabot</td><td><a href=".gitbook/assets/2.png">2.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Developer Guide</strong></td><td>Learn how to develop for Hexabot</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><strong>Key Concepts</strong></td><td>Understanding the Fundamentals of Chatbot Building</td><td><a href=".gitbook/assets/3.png">3.png</a></td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
<table data-view="cards">
<thead>
<tr>
<th></th>
<th></th>
<th data-hidden data-card-cover data-type="files"></th>
<th data-hidden></th>
<th data-hidden data-card-target data-type="content-ref"></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Getting Started</strong></td>
<td>Install Hexabot and create your first flow</td>
<td><a href=".gitbook/assets/1.png">1.png</a></td>
<td></td>
<td><a href="quickstart/installation.md">installation.md</a></td>
</tr>
<tr>
<td><strong>Product overview</strong></td>
<td>Key Features and Capabilities</td>
<td><a href=".gitbook/assets/4.png">4.png</a></td>
<td></td>
<td><a href="introduction/overview.md">introduction/overview.md</a></td>
</tr>
<tr>
<td><strong>User Guide</strong></td>
<td>Learn the basics of Hexabot</td>
<td><a href=".gitbook/assets/2.png">2.png</a></td>
<td></td>
<td><a href="user-guide/README.md">user-guide/README.md</a></td>
</tr>
<tr>
<td><strong>Developer Guide</strong></td>
<td>Learn how to develop for Hexabot</td>
<td><a href=".gitbook/assets/3.png">3.png</a></td>
<td></td>
<td><a href="developer-guide/README.md">developer-guide/README.md</a></td>
</tr>
<tr>
<td><strong>Key Concepts</strong></td>
<td>Understanding the Fundamentals of Chatbot Building</td>
<td><a href=".gitbook/assets/3.png">3.png</a></td>
<td></td>
<td><a href="key-concepts/README.md">key-concepts/README.md</a></td>
</tr>
</tbody>
</table>
🤖 Prompt for AI Agents
In docs/README.md around line 57, the table contains several <a
href="broken-reference">Broken link</a> placeholders; replace each
"broken-reference" href with the correct relative path to the actual page in the
repo (e.g., product/overview.md, user-guide/index.md, developer-guide/index.md,
key-concepts/index.md or whatever the real file names are in this repo), ensure
the linked files exist, update the link text if needed, and run a quick link
check to confirm all anchors resolve; if the exact targets differ, use the
appropriate existing doc paths.


78 changes: 78 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Table of contents

* [Welcome](README.md)

## Introduction

* [Overview](introduction/overview.md)
* [Features](introduction/features.md)

## Quickstart

* [Installation](quickstart/installation.md)
* [Create your first flow](quickstart/create-your-first-flow.md)

## USER GUIDE

* [Visual Editor](user-guide/visual-editor/README.md)
* [Using the Visual Editor](user-guide/visual-editor/using-the-visual-editor.md)
* [Regular Blocks](user-guide/visual-editor/regular-blocks/README.md)
* [Using Simple Text Block](user-guide/visual-editor/regular-blocks/using-simple-text-block.md)
* [Using Quick Replies Block](user-guide/visual-editor/regular-blocks/using-quick-replies-block.md)
* [Using Buttons Block](user-guide/visual-editor/regular-blocks/using-buttons-block.md)
* [Using Attachment Block](user-guide/visual-editor/regular-blocks/using-attachment-block.md)
* [Using Advanced Blocks](user-guide/visual-editor/using-advanced-blocks.md)
* [Flows](user-guide/flows.md)
* [NLU](user-guide/nlu/README.md)
* [NLU Engines](user-guide/nlu/nlu-engines/README.md)
* [LLM NLU Engine](user-guide/nlu/nlu-engines/llm-nlu-engine.md)
* [Ludwig NLU Engine](user-guide/nlu/nlu-engines/ludwig-nlu-engine.md)
* [Tensorflow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Correct proper noun capitalization: TensorFlow

Spelling should be “TensorFlow”.

-    * [Tensorflow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)
+    * [TensorFlow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* [Tensorflow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)
* [TensorFlow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)
🧰 Tools
🪛 LanguageTool

[grammar] ~31-~31: There might be a mistake here.
Context: ...-engine.md) * Tensorflow NLU Engine * [NLU Training](user-guide/nlu-training.md...

(QB_NEW_EN)

🤖 Prompt for AI Agents
In docs/SUMMARY.md around line 31 the proper noun "Tensorflow" is incorrectly
capitalized; change it to "TensorFlow" in the list entry so the line reads "*
[TensorFlow NLU Engine](user-guide/nlu/nlu-engines/tensorflow-nlu-engine.md)" to
correct the spelling/capitalization.

* [Manage NLU Entities](user-guide/nlu/manage-nlu-entities.md)
* [NLU Match Scoring](user-guide/nlu/nlu-match-scoring.md)
* [NLU Training](user-guide/nlu-training.md)
* [Knowledge Base](user-guide/knowledge-base/README.md)
* [Content Types](user-guide/knowledge-base/content-types.md)
* [Manage Persistent Menu](user-guide/knowledge-base/manage-persistent-menu.md)
* [Media Library](user-guide/knowledge-base/media-library.md)
* [Localization](user-guide/localization/README.md)
* [Languages](user-guide/localization/languages.md)
* [Translations](user-guide/localization/translations.md)
* [Users and Roles](user-guide/users-and-roles/README.md)
* [Manage users](user-guide/users-and-roles/manage-users.md)
* [Manage roles](user-guide/users-and-roles/manage-roles.md)
* [Manage Settings](user-guide/manage-settings/README.md)
* [Email](user-guide/manage-settings/email.md)
* [Chatbot Global Fallback](user-guide/manage-settings/chatbot-global-fallback.md)
* [NLU Provider](user-guide/manage-settings/nlu-provider.md)
* [Web Channel](user-guide/manage-settings/web-channel.md)
* [Live chat widget](user-guide/manage-settings/live-chat-widget.md)
* [Facebook Messenger](user-guide/manage-settings/facebook-messenger.md)
* [Context Variables](user-guide/context-variables.md)
* [Chat Inbox](user-guide/chat-inbox.md)
* [Subscribers](user-guide/subscribers.md)
* [Analytics Dashboard](user-guide/analytics-dashboard.md)

## FAQ

* [How can I deploy my Hexabot using NGINX ?](faq/how-can-i-deploy-my-hexabot-using-nginx.md)
* [How can I add the Chatbot Widget to my Website?](faq/how-can-i-add-the-chatbot-widget-to-my-website.md)

## Developer Guide

* [Contributors Installation Guide](developer-guide/contributors-installation-guide.md)
* [CLI Command Reference](developer-guide/cli-command-reference.md)
* [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)
* [SMTP Configuration and Emails](developer-guide/smtp-configuration-and-emails.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)
* [Hexabot NLU Engine](developer-guide/hexabot-nlu-engine.md)
* [Training custom NLU Models with Ludwig AI](developer-guide/training-custom-nlu-models-with-ludwig-ai.md)

## Key Concepts

* [NLU](key-concepts/nlu.md)
* [Intent](key-concepts/intent.md)
163 changes: 163 additions & 0 deletions docs/developer-guide/cli-command-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
---
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.

Not yet familiar with [Hexabot](https://hexabot.ai/)? It's a open-source chatbot / agent solution that allows users to create and manage AI-powered, multi-channel, and multilingual chatbots with ease. If you would like to learn more, please visit the [official github repo](https://github.com/Hexastack/Hexabot/).

### Getting Started

#### Prerequisites

* Node.js >= 18.17.0
* npm (Node Package Manager)
* Docker installed

#### Installation

Install Hexabot CLI globally to have easy access to its commands:

```
npm install -g hexabot-cli
```

#### Usage

Once installed, you can use the `hexabot` command in your terminal. Here are some of the available commands:

#### Commands

**`create <projectName>`**

Create a new Hexabot project.

```
hexabot create my-chatbot
```

Options:

* `--template <template>`: Specify a GitHub repository in the format `GITHUB_USERNAME/GITHUB_REPO` to use a custom template.

Example:

```
hexabot create my-chatbot --template myusername/my-template-repo
```

**`init`**

Initialize the environment by copying `.env.example` to `.env`.

```
hexabot init
```

**`dev`**

Start specified services in development mode with Docker Compose.

```
hexabot dev --services nlu,ollama
```

Options:

* `--services <services>`: Comma-separated list of services to enable.

**`start`**

Start specified services with Docker Compose.

```
hexabot start --services api,nlu
```

Options:

* `--services <services>`: Comma-separated list of services to enable.

**`migrate [args...]`**

Run database migrations.

```
hexabot migrate
```

You can also pass additional arguments to the migration command.

**`start-prod`**



Start specified services in production mode with Docker Compose.

```
hexabot start-prod --services api,nlu
```

Options:

* `--services <services>`: Comma-separated list of services to enable.

**`stop`**

Stop specified Docker Compose services.

```
hexabot stop --services api,nlu
```

Options:

* `--services <services>`: Comma-separated list of services to stop.

**`destroy`**

Destroy specified Docker Compose services and remove volumes.

```
hexabot destroy --services api,nlu
```

Options:

* `--services <services>`: Comma-separated list of services to destroy.

### Example Workflow

1. **Create a new project**:

```
hexabot create my-chatbot
```

This will create a new folder `my-chatbot` with all necessary files to get started.
2. **Navigate to your project folder**:

```
cd my-chatbot
```
3. **Install dependencies**:

```
npm install
```
4. **Initialize environment**:

```
hexabot init
```

This command copies the `.env.example` file to `.env`, which you can edit to customize your configuration.
5. **Run in development mode**:

```
hexabot dev --services nlu,ollama
```

This starts the required services in development mode.
Loading