# Documentation

This page shows the developer documentation of Botge.

## Deployment diagram

<figure><img src="https://3046792365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGmWCLpY0aGqtpW6PUlwF%2Fuploads%2F6wHPt8eaptcI7UXVpP4a%2FDocker.png?alt=media&#x26;token=736c9d45-061a-477a-9fed-0dd9e0d36b4b" alt="deployment diagram image"><figcaption></figcaption></figure>

This diagram outlines the general deployment of Botge.\
It outlines how the bot interacts with other APIs, how it uses technologies to implement the commands.

***

## Bot class diagram

<figure><img src="https://3046792365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGmWCLpY0aGqtpW6PUlwF%2Fuploads%2F3iI9eDuKBobng5HTnxQ3%2FBot.png?alt=media&#x26;token=b101a102-d9d2-4d11-bc63-13018fc90a43" alt="bot class diagram image"><figcaption></figcaption></figure>

This diagram shows the shortened structure of Botge.\
The central class is Bot, which connects all the other classes together.

***

## Bot start flowchart

<figure><img src="https://3046792365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGmWCLpY0aGqtpW6PUlwF%2Fuploads%2FV5iNRwsGAPBqA4LVfILM%2FIndexStart.png?alt=media&#x26;token=8234e1e5-7cce-4859-ad06-a4d00fa01d36" alt="bot start flowchart image"><figcaption></figcaption></figure>

This flowchart shows the process of starting the bot.

***

## Interaction flowchart

<figure><img src="https://3046792365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGmWCLpY0aGqtpW6PUlwF%2Fuploads%2Fs2u4LzfVRfhuBfHp2ii0%2FInteraction.png?alt=media&#x26;token=cf718dec-cc3e-4355-8114-fd1f78e5af9a" alt="interaction flowchart image"><figcaption></figcaption></figure>

This flowchart presents how an interaction is processed then converted into an output.

***

## Command outline and dataflow

<figure><img src="https://3046792365-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FGmWCLpY0aGqtpW6PUlwF%2Fuploads%2Fx1uBz3X1zhJeGyrn6Lrr%2FDataflowge.png?alt=media&#x26;token=c556b0dc-c628-4b21-865b-b15ef783d929" alt="command outline and dataflow image"><figcaption></figcaption></figure>

This dataflow chart is a simple outline of how a command reaches the bot and how the output is sent back to the user.