Social Bots Documentation Update

2021-04-12 23:06:13 +12:00
1 parent 942f518ba5
commit 68686165c3
@@ -1,3 +1,19 @@
 {
-    "type": "Social Bots"
+    "type": "Social Bots",
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "The Social Bots node contains children nodes for each messaging bot. These messaging bots are used to configure the third party applications used to send announcements and receive incoming commands.",
+            "updated": 1618221943424
+        },
+        {
+            "style": "Note",
+            "text": "At present Superalgos only supports the Telegram messaging application.",
+            "updated": 1618221056200
+        }
+    ],
+    "definition": {
+        "text": "A Social Bots node is used to define the bots for each messaging application. These messaging bots are used to send announcements and receive commands used to interact with Superalgos.",
+        "updated": 1618222853055
+    }
 }
@@ -1,3 +1,59 @@
 {
-    "type": "Telegram Bot"
+    "type": "Telegram Bot",
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "The Telegram Bot node is used to define the botToken and chatId parameters which are required by Superalgos to interact with the Telegram API.",
+            "updated": 1618224117691
+        },
+        {
+            "style": "Text",
+            "text": "The botToken parameter is provided by the Telegram Bot @BotFather. It is a 10 digit number, followed by a colon and then a 35 character (alpha-numeric but can also containing dash - and underscore _) string.",
+            "updated": 1618224138149
+        },
+        {
+            "style": "Text",
+            "text": "It should be contained within quotes."
+        },
+        {
+            "style": "Text",
+            "text": "Example:",
+            "updated": 1618223886054
+        },
+        {
+            "style": "Javascript",
+            "text": "\"1234567890:aBCdE_FG4hij0kLMnoP9qrsTUvw25-xyz31\"",
+            "updated": 1618223916419
+        },
+        {
+            "style": "Text",
+            "text": "The chatId parameter is provided by the Telegram Bot @myidbot using the /getgroupid command. It is a negative 9 digit numeric number. It should be entered without quotes.",
+            "updated": 1618224061206
+        },
+        {
+            "style": "Text",
+            "text": "Example:"
+        },
+        {
+            "style": "Javascript",
+            "text": "-123456789"
+        },
+        {
+            "style": "Subtitle",
+            "text": "Example Configuration"
+        },
+        {
+            "style": "Javascript",
+            "text": "{\n\t\"botToken\": \"1234567890:aBCdE_FG4hij0kLMnoP9qrsTUvw25-xyz31\",\n\t\"chatId\": -123456789\n }",
+            "updated": 1618224233921
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ],
+    "definition": {
+        "text": "The Telegram Bot node is used to define the parameters used to connect to the Telegram API. This allows Superalgos to interact with Telegram to send announcements and receive incoming commands.",
+        "updated": 1618220722404
+    }
 }