From 655bdf2126b5e951b6a885bcac8781a551bdc56d Mon Sep 17 00:00:00 2001
From: InsanusMokrassar <ovsyannikov.alexey95@gmail.com>
Date: Sat, 30 Sep 2023 13:02:08 +0600
Subject: [PATCH] start add plagubot manuals

---
 docs/tgbotapi/plagubot/index.md | 49 +++++++++++++++++++++++++++++++++
 mkdocs.yml                      |  2 ++
 2 files changed, 51 insertions(+)
 create mode 100644 docs/tgbotapi/plagubot/index.md

diff --git a/docs/tgbotapi/plagubot/index.md b/docs/tgbotapi/plagubot/index.md
new file mode 100644
index 0000000..a27108f
--- /dev/null
+++ b/docs/tgbotapi/plagubot/index.md
@@ -0,0 +1,49 @@
+# PlaguBot
+
+[PlaguBot](https://github.com/InsanusMokrassar/PlaguBot) is a small framework for unifying developing of modules of bots. It is built with two parts:
+
+* [Plugin](https://github.com/InsanusMokrassar/PlaguBot/blob/master/plugin/src/main/kotlin/dev/inmo/plagubot/Plugin.kt)
+* [Bot](https://github.com/InsanusMokrassar/PlaguBot/tree/master/bot/src/main/kotlin/dev/inmo/plagubot)
+
+## Plugin
+
+Plugin is a partially independent part of bot. Plugin have several parts:
+
+* `setupDI` - this method should be used to configure DI part of module
+* `setupBotPlugin` - method to start/configure your bot actions
+
+Plugin realization should be an `object` or `class` with empty constructor.
+
+## Bot
+
+Most important of bot is `main` function (full reference: `dev.inmo.plagubot.AppKt`). It consumes one argument - path to config.
+
+Bot is initializing with the next algorithm:
+
+```mermaid
+flowchart TB
+    main["Main"]
+
+    subgraph ConfigReading
+        ConfigJsonParsing["Parsing to Json"]
+        ConfigParsing["Parsing to global config"]
+        ConfigJsonParsing --> ConfigParsing
+    end
+    ConfigReading["Reading of config"]
+    
+    BotConstructorCalling["Calling of PlaguBot constructor"]
+
+    subgraph BotStart
+        BotStartKoinAppInit["Initialization of koin app"]
+        
+        subgraph BotStartSetupDI
+            sample
+        end
+        
+        BotStartKoinAppInit --> BotStartSetupDI
+    end
+    
+    main --> ConfigReading
+    ConfigReading --> BotConstructorCalling
+    BotConstructorCalling --> BotStart
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index fec33d8..d89aeca 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -28,6 +28,8 @@ nav:
             - 'tgbotapi/updates/heroku.md'
         - Logic handling: 'tgbotapi/logic/'
         - DSLs: 'tgbotapi/dsls/'
+        - PlaguBot (TBD):
+              - 'tgbotapi/plagubot/'
     - 'Krontab':
         - 'krontab/index.md'
         - KDocs: 'https://krontab.inmo.dev/'