diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/asset.json b/Projects/Superalgos/Schemas/Docs-Nodes/asset.json index 4e6371aa7..930d1a11f 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/asset.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/asset.json @@ -1,36 +1,43 @@ { "type": "Asset", "definition": { - "text": "An asset node is the definition of an asset listed at the corresponding exchange." + "text": "An asset node is the definition of an asset in Superalgos.", + "updated": 1609771995506 }, "paragraphs": [ { "style": "Block", - "text": "Configuring" + "text": "Content", + "updated": 1609772067590 + }, + { + "style": "Text", + "text": "Assets defined under the Exchange Assets node may then be used to define markets, or to define holdings denominated in these assets under the User Assets node.", + "updated": 1609772147353 + }, + { + "style": "Block", + "text": "Configuring", + "updated": 1609772157097 }, { "style": "Title", - "text": "Configuring Asset" + "text": "" }, { - "style": "Text", - "text": "Select Configure Asset on the menu to access the configuration." + "style": "Title", + "text": "Asset Configuration", + "updated": 1609772023763 }, { - "style": "Text", - "text": "{" + "style": "Subtitle", + "text": "Properties", + "updated": 1609772168896 }, { - "style": "Text", - "text": "\"codeName\": \"BTC\"" - }, - { - "style": "Text", - "text": "}" - }, - { - "style": "Text", - "text": " codeName is the ticker of the asset as listed by the exchange (i.e.:* BTC, BTH, ETH, LTC, BNB, USDT, USD, etc.)" + "style": "List", + "text": "codeName is the ticker of the asset as listed by the exchange (i.e. BTC, BTH, ETH, LTC, BNB, USDT, USD, etc.)", + "updated": 1609772199109 }, { "style": "Note", diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchange.json b/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchange.json index 266e30299..0824a262c 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchange.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchange.json @@ -10,55 +10,13 @@ }, { "style": "Title", - "text": "Configuring Crypto Exchange" + "text": "Crypto Exchange Configuration", + "updated": 1609771676751 }, { - "style": "Text", - "text": "Select Configure Crypto Exchange on the menu to access the configuration." - }, - { - "style": "Text", - "text": "{" - }, - { - "style": "Text", - "text": " \"codeName\": \"binance\"," - }, - { - "style": "Text", - "text": " \"API\": [" - }, - { - "style": "Text", - "text": " {" - }, - { - "style": "Text", - "text": " \"method\": \"fetchTrades\"," - }, - { - "style": "Text", - "text": " \"fetchType\": \"by Id\"," - }, - { - "style": "Text", - "text": " \"fetchTradesMethod\": \"publicGetHistoricalTrades\"," - }, - { - "style": "Text", - "text": " \"firstId\": \"f\"" - }, - { - "style": "Text", - "text": " }" - }, - { - "style": "Text", - "text": " ]" - }, - { - "style": "Text", - "text": "}" + "style": "Subtitle", + "text": "Properties", + "updated": 1609771684679 }, { "style": "List", diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchanges.json b/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchanges.json index 32bb5b501..a3f380abc 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchanges.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/crypto-exchanges.json @@ -3,5 +3,30 @@ "definition": { "text": "The crypto exchanges node groups definitions of the different exchanges the user may interact with." }, - "paragraphs": [] + "paragraphs": [ + { + "style": "Text", + "text": "The default workspace features several nodes of this type, each with a purpose:", + "updated": 1609771412437 + }, + { + "style": "List", + "text": "Tested: features Crypto Exchange nodes of exchanges that have been thoroughly tested.", + "updated": 1609771181080 + }, + { + "style": "List", + "text": "Untested: features a collection of Crypto Exchange nodes of untested exchanges that comply with the set of API requirements of the CCXT library that Superalgos needs to function.", + "updated": 1609771650992 + }, + { + "style": "List", + "text": "Testing Queue: you may use this node to deploy Crypto Exchange nodes while testing them.", + "updated": 1609771442675 + }, + { + "style": "Text", + "text": "" + } + ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-accounts.json b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-accounts.json index 9ba90989b..36fbc9851 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-accounts.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-accounts.json @@ -3,5 +3,15 @@ "definition": { "text": "The exchange accounts node groups the different accounts the user may have with the corresponding exchange." }, - "paragraphs": [] + "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1609777103880 + }, + { + "style": "Text", + "text": "This section of the Crypto Ecosystem hierarchy deals with concepts related to the user." + } + ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-assets.json b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-assets.json index 447f5f27f..b362513cd 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-assets.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-assets.json @@ -1,7 +1,8 @@ { "type": "Exchange Assets", "definition": { - "text": "The exchange assets node groups the definitions of assets." + "text": "The exchange assets node groups the definitions of assets that may be used to define markets under the Exchange Markets node.", + "updated": 1609771958983 }, "paragraphs": [ { @@ -10,26 +11,16 @@ }, { "style": "Title", - "text": "Configuring Exchange Assets" + "text": "Exchange Assets Configuration", + "updated": 1609771814727 }, { - "style": "Text", - "text": "Select Configure Exchange Assets on the menu to access the configuration." + "style": "Subtitle", + "text": "Properties", + "updated": 1609771820241 }, { - "style": "Text", - "text": "{" - }, - { - "style": "Text", - "text": "\"addMissingAssets\": { \"quotedAsset\": \"BTC\"}" - }, - { - "style": "Text", - "text": "}" - }, - { - "style": "Text", + "style": "List", "text": " addMissingAssets acts as a filter to determine which assets of a (potentially long) list of assets listed at the exchange will be added when the Add Missing Assets* option in the menu is used. Because many exchanges do not offer a list of assets, the system fetches assets from actual markets (pairs) listed at the exchange. You may add missing assets filtered by the quotedAsset or by the baseAsset. For example, the above configuration would add all assets listed in markets in which BTC is the quoted asset." } ] diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-markets.json b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-markets.json index 298f320d4..d093ec3b3 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/exchange-markets.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/exchange-markets.json @@ -3,5 +3,11 @@ "definition": { "text": "The exchange markets node groups the definitions of markets." }, - "paragraphs": [] + "paragraphs": [ + { + "style": "Text", + "text": "There is no limit as of how many markets may be defined.", + "updated": 1609772386734 + } + ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/market.json b/Projects/Superalgos/Schemas/Docs-Nodes/market.json index 7aac10715..b6067aaab 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/market.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/market.json @@ -11,6 +11,16 @@ { "style": "Important", "text": "Only markets that are effectively listed on the exchange may be configured and used with the system. Check with the exchange and make sure you understand what tickers they are using, which is the base asset and which the quoted asset on the listed markets." + }, + { + "style": "Block", + "text": "Configuring", + "updated": 1609772445354 + }, + { + "style": "Title", + "text": "Market Configuration", + "updated": 1609772469334 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/user-account.json b/Projects/Superalgos/Schemas/Docs-Nodes/user-account.json index 2a8391068..4ce3b8cc7 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/user-account.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/user-account.json @@ -3,5 +3,16 @@ "definition": { "text": "A user account represents a single account with the corresponding exchange, holding the definitions of user assets, including keys and balances." }, - "paragraphs": [] + "paragraphs": [ + { + "style": "Block", + "text": "Content", + "updated": 1609777192116 + }, + { + "style": "Text", + "text": "For exchanges that support multiple accounts or subaccounts, use one User Account for each of them.", + "updated": 1609777221616 + } + ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/user-assets.json b/Projects/Superalgos/Schemas/Docs-Nodes/user-assets.json index f47c019da..5980d0503 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/user-assets.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/user-assets.json @@ -3,5 +3,10 @@ "definition": { "text": "The user assets node groups the assets the user has at the exchange." }, - "paragraphs": [] + "paragraphs": [ + { + "style": "Text", + "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + } + ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Nodes/user-keys.json b/Projects/Superalgos/Schemas/Docs-Nodes/user-keys.json index 791e333af..235a3abd7 100644 --- a/Projects/Superalgos/Schemas/Docs-Nodes/user-keys.json +++ b/Projects/Superalgos/Schemas/Docs-Nodes/user-keys.json @@ -3,5 +3,11 @@ "definition": { "text": "The user keys node groups the various exchange account keys the user may have under the corresponding account with the exchange." }, - "paragraphs": [] + "paragraphs": [ + { + "style": "Text", + "text": "You may want to have multiple exchange account keys under the same User Account to trade, for instance, with different trading systems, or different kinds of trading sessions.", + "updated": 1609777414403 + } + ] } \ No newline at end of file