📝 Docs

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.
 

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
+   tt

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`
+.. automodule::tt.plugins.default_plugins.cex_exchange_plugin

docs/plugins/dex.rst

@@ -2,9 +2,7 @@
 DEX
 ===
 
-
 Module Reference
 ================
 
 :doc:`dxsp:index`
-

docs/plugins/helper.rst

@@ -2,28 +2,40 @@
 helper
 =====
 
+Provide multiple function such as giving the list of 
+available command, network ping or restarting the bot
+
+.. toctree::
+   :maxdepth: 2
+
+   plugins/helper
+
 
 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`
+.. automodule::tt.plugins.default_plugins.helper_plugin

docs/plugins/myllm.rst

@@ -2,12 +2,7 @@
 MyLLM
 =====
 
-
-
-
-
-
 Module Reference
 ================
 
-:doc:`myllm:index`
+:doc:`myllm:index`

docs/plugins/talkytrend.rst

@@ -5,5 +5,4 @@ Talkytrend
 Module Reference
 ================
 
-
-:doc:`talkytrend:index`
+:doc:`talkytrend:index`