From cce447a11d0b2052ca0a92d7aaf7011d5ad1694d Mon Sep 17 00:00:00 2001
From: mraniki <8766259+mraniki@users.noreply.github.com>
Date: Mon, 7 Aug 2023 15:55:09 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Docs?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/01_start.rst           |  6 ++--
 docs/03_module.rst          | 68 ++++++++++++++++++++++++++++++++++---
 docs/plugins/cex.rst        | 22 ++----------
 docs/plugins/dex.rst        |  2 --
 docs/plugins/helper.rst     | 14 +++++++-
 docs/plugins/myllm.rst      |  7 +---
 docs/plugins/talkytrend.rst |  3 +-
 7 files changed, 85 insertions(+), 37 deletions(-)

diff --git a/docs/01_start.rst b/docs/01_start.rst
index e815a82a5..e70529dde 100644
--- a/docs/01_start.rst
+++ b/docs/01_start.rst
@@ -14,11 +14,13 @@ Create your channel/room and your platform bot:
 Exchange Credentials
 ====================
 
-- DEX wallet address and private key: :doc:`plugins/dex`
-- CEX API Keys: :doc:`plugins/cex`
+Get your DEX or CEX credentials:
+- DEX wallet address and private key: :doc:`talky:plugins/dex`
+- CEX API Keys: :doc:`talky:plugins/cex`
 
 Setup your config
 =================
+
 Create your config file settings.toml or use env variables. 
 Refer to  :doc:`talky:02_config` for details.
 
diff --git a/docs/03_module.rst b/docs/03_module.rst
index 5de0ac40a..505583248 100644
--- a/docs/03_module.rst
+++ b/docs/03_module.rst
@@ -1,10 +1,70 @@
-==================
-TalkyTrader Module
-==================
+===========
+TalkyTrader
+===========
+
+API EndPoint
+============
+
+Talky Trader is an app built with FastAPI https://fastapi.tiangolo.com
+It allows you to connect to a messaging chat platform to interact with
+trading module.
+
+HealthCheck
+-----------
+
+End point to know if the API is up and running
+
+.. autofunction::tt.bot.health_check
+
+Webhook
+-------
+
+Webhook endpoint to send your trade generated via http://tradingview.com 
+or anyother platform you work with.
+Endpoint is :file:`/webhook/{settings.webhook_secret}` so in trading view you can add:
+https://talky.trader.com/webhook/123456
+
+.. autofunction::tt.bot.webhook
+
+Startup
+-------
+
+Starting the coroutine run_bot
+
+.. autofunction::tt.bot.start_bot_task
+
+
+iamlistening
+============
+
+:doc:`iamlistening:index`
+
+
+FindMyOrder
+===========
+
+:doc:`findmyorder:index`
+
+Plugins
+=======
+
+Plugins are the core of Talky Trader, they are loaded at startup and
+are used to interact with the trading platform.
+
+
+.. toctree::
+   :maxdepth: 2
+   
+   plugins
+
+
+
+TalkyTrader Module Reference
+=====================
 
 .. autosummary::
    :toctree: _autosummary
    :template: custom-module-template.rst
    :recursive:
 
-   tt
\ No newline at end of file
+   tt
diff --git a/docs/plugins/cex.rst b/docs/plugins/cex.rst
index 95450b7df..1acfe3dbb 100644
--- a/docs/plugins/cex.rst
+++ b/docs/plugins/cex.rst
@@ -2,30 +2,12 @@
 CEX
 ===
 
-
 User Guide
 ==========
-- CEX API Keys
-
-SPOT
-----
-
-
-LIMIT ORDER 
------------
-
-
-MARGIN ORDER 
-------------
-
-
-FUTURE ORDER 
-------------
+- Retrieve your CEX API Keys
 
 
 Module Reference
 ================
 
-
-
-:doc:`cex:index`
\ No newline at end of file
+.. automodule::tt.plugins.default_plugins.cex_exchange_plugin
diff --git a/docs/plugins/dex.rst b/docs/plugins/dex.rst
index 7eebb6289..e7a3146c8 100644
--- a/docs/plugins/dex.rst
+++ b/docs/plugins/dex.rst
@@ -2,9 +2,7 @@
 DEX
 ===
 
-
 Module Reference
 ================
 
 :doc:`dxsp:index`
-
diff --git a/docs/plugins/helper.rst b/docs/plugins/helper.rst
index 0d48185f6..88d93f00c 100644
--- a/docs/plugins/helper.rst
+++ b/docs/plugins/helper.rst
@@ -2,6 +2,14 @@
 helper
 =====
 
+Provide multiple function such as giving the list of 
+available command, network ping or restarting the bot
+
+.. toctree::
+   :maxdepth: 2
+   
+   plugins/helper
+
 
 Function
 =====
@@ -9,21 +17,25 @@ Function
 Help
 ----
 
+:file:`/help` command to return the list of available command
 
 Trading Switch
 --------------
 
+:file:`/trading` command to turn off or on the trading capability
 
 Network
 -------
 
+:file:`/network` command to retrieve the network ping latency and IP of the bot
 
 Restart
 --------
 
+:file:`/restart` command to restart the bot
 
 
 Module Reference
 ================
 
-:doc:`iamlistening:index`
\ No newline at end of file
+.. automodule::tt.plugins.default_plugins.helper_plugin
\ No newline at end of file
diff --git a/docs/plugins/myllm.rst b/docs/plugins/myllm.rst
index b655b6d7e..c402d232d 100644
--- a/docs/plugins/myllm.rst
+++ b/docs/plugins/myllm.rst
@@ -2,12 +2,7 @@
 MyLLM
 =====
 
-
-
-
-
-
 Module Reference
 ================
 
-:doc:`myllm:index`
\ No newline at end of file
+:doc:`myllm:index`
diff --git a/docs/plugins/talkytrend.rst b/docs/plugins/talkytrend.rst
index 3aac34b13..7f8b3beb5 100644
--- a/docs/plugins/talkytrend.rst
+++ b/docs/plugins/talkytrend.rst
@@ -5,5 +5,4 @@ Talkytrend
 Module Reference
 ================
 
-
-:doc:`talkytrend:index`
\ No newline at end of file
+:doc:`talkytrend:index`