Merge pull request #565 from julian-molina/develop

Contribution: Contributing to Superalgos

.gitignore

@@ -4,3 +4,6 @@ My-Workspaces
 debug.log
 .DS_Store
 *.db
+Projects/Superalgos/Icons/Thumbs.db
+Projects/Superalgos/Icons/Thumbs.db
+Projects/Superalgos/Icons/Thumbs.db

Projects/Superalgos/Schemas/Docs-Concepts/reusable-snippets.json

@@ -140,9 +140,28 @@
             "text": "THIS IS NOT FINANCIAL ADVICE. ALTHOUGH STRATEGIES SHIPPING WITH SUPERALGOS MAY BE FULLY FUNCTIONAL, SUPERALGOS DOES NOT MAKE ANY EXPRESS OR IMPLIED RECOMMENDATION AS OF HOW YOU SHOULD USE THEM. WE SHARE STRATEGIES FOR EDUCATIONAL PURPOSES ONLY. TRADE AT YOUR OWN RISK.<br/><br/><b>Performance in backtesting is not an indication of live trading performance.</b> Live performance may vary in relation to performance in backtesting, for better or for worse, most likely for worse. This happens because the design of trading strategies is done after the fact, with the hindsight of what happened in a certain range of the market. Patterns upon which strategies may be based on may keep occurring or not. Trading strategies attempt to interpret patterns and predict what may follow, but they are far from being perfect or accurate. The best-case scenario is a strategy being right more times than it is wrong.<br/><br/><b>Live performance is not an indication of future performance. </b>Similarly, even when a strategy has delivered a certain performance trading live, there is no guarantee of what performance the strategy may achieve in the future. Live performance results are certainly more valuable than backtesting or simulated performance but still can’t predict the future.<br/><br/><b>Trading strategies lose effectiveness with time. </b>How much time? No-one knows. Markets evolve, change, go through different cycles, both long and short-term, some of which may not have been tested. That is true for all markets, let alone crypto, which is a very young market, still in its very early stages. Crypto markets change dramatically fast, as the market cap increases, more pro-traders enter the space, more smart money pours larger capitals, more bots take over operations of ever-increasing volumes, more complexity is added to the ecosystem with the availability of derivative markets, and so on.",
             "updated": 1611676109591
         },
+        {
+            "style": "Title",
+            "text": "Contributions Reminder",
+            "updated": 1613588536814
+        },
         {
             "style": "Block",
-            "text": "Dummy"
+            "text": "Contributions Reminder"
+        },
+        {
+            "style": "Note",
+            "text": "All contributions must be submitted to the Develop branch. Make sure you update to the latest version in Develop and that everything you are submitting works properly in that version.",
+            "updated": 1613588289291
+        },
+        {
+            "style": "Block",
+            "text": "Dummy",
+            "updated": 1613588341297
+        },
+        {
+            "style": "Text",
+            "text": ""
         },
         {
             "style": "Text",

Projects/Superalgos/Schemas/Docs-Nodes/image.json

@@ -32,26 +32,6 @@
             "style": "Title",
             "text": "Configuring Image"
         },
-        {
-            "style": "Text",
-            "text": "Select Configure on the menu to access the configuration."
-        },
-        {
-            "style": "Text",
-            "text": "{"
-        },
-        {
-            "style": "Text",
-            "text": "   \"codeName\": \"imagename\","
-        },
-        {
-            "style": "Text",
-            "text": "   \"size\": 15"
-        },
-        {
-            "style": "Text",
-            "text": "}"
-        },
         {
             "style": "List",
             "text": "codeName is the name of the image, without the .png extension."

Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-001-how-to-contribute-a-trading-system.json

@@ -0,0 +1,121 @@
+{
+    "topic": "Contributing to Superalgos",
+    "pageNumber": "1",
+    "type": "How to Contribute a Trading System",
+    "definition": {
+        "text": "To contribute a Trading System, you must provide the trading system file, a clean workspace, and proper documentation.",
+        "updated": 1613586065560
+    },
+    "paragraphs": [
+        {
+            "style": "Include",
+            "text": "Superalgos->Concept->Reusable Snippets->Contributions Reminder",
+            "updated": 1613588504452
+        },
+        {
+            "style": "Title",
+            "text": "Requirements"
+        },
+        {
+            "style": "Subtitle",
+            "text": "Trading System File",
+            "updated": 1613586209394
+        },
+        {
+            "style": "List",
+            "text": "Prepare a clean and tidy Trading System. Organize and name strategies, situations, conditions, orders, etc. so that it's easier to read.",
+            "updated": 1613586689994
+        },
+        {
+            "style": "List",
+            "text": "Add the Trading System file as a plugin in the proper folder.",
+            "updated": 1613586830612
+        },
+        {
+            "style": "Json",
+            "text": "Plugins/Trading-Systems"
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
+        {
+            "style": "Subtitle",
+            "text": "Workspace File",
+            "updated": 1613586227342
+        },
+        {
+            "style": "List",
+            "text": "Prepare a clean Workspace featuring your Trading System and the required data mines only.",
+            "updated": 1613586969193
+        },
+        {
+            "style": "List",
+            "text": "Install the Market and remove the unnecessary Data Tasks so that users know what indicators are required. Make sure you remove the unnecessary Data Storage nodes too.",
+            "updated": 1613586983832
+        },
+        {
+            "style": "List",
+            "text": "Add a Workspace file as a workspace plugin in the appropriate folder.",
+            "updated": 1613587034029
+        },
+        {
+            "style": "Json",
+            "text": "Plugins/Workspaces",
+            "updated": 1613587162166
+        },
+        {
+            "style": "Subtitle",
+            "text": "Documentation",
+            "updated": 1613587174588
+        },
+        {
+            "style": "List",
+            "text": "Take the BB Top Bounce (BBTB) page as an example of the content you should provide as documentation for the trading system.",
+            "updated": 1613588848793
+        },
+        {
+            "style": "List",
+            "text": "The name of the page you create must follow the following format...",
+            "updated": 1613587567753
+        },
+        {
+            "style": "Json",
+            "text": "[Market] - Trading System Name"
+        },
+        {
+            "style": "Text",
+            "text": "For example:",
+            "updated": 1613587598566
+        },
+        {
+            "style": "Json",
+            "text": "BTC-USDT - BB Top Bounce (BBTB)"
+        },
+        {
+            "style": "List",
+            "text": "The above assumes that the Trading System is optimized for a specific Market. Even if that is not the case, specify the market the is installed in the Workspace file.",
+            "updated": 1613587803249
+        },
+        {
+            "style": "List",
+            "text": "Create the page within the Community Trading Systems topic. You may edit the command below to fit your needs.",
+            "updated": 1613587940298
+        },
+        {
+            "style": "Json",
+            "text": "docs.add Topic to Superalgos: Community Trading Systems->BTC-USDT - Strategy Name",
+            "updated": 1613588675025
+        },
+        {
+            "style": "Title",
+            "text": "Optional Content",
+            "updated": 1613588691827
+        },
+        {
+            "style": "Text",
+            "text": "Consider creating an interactive Tutorial that goes through the implementation of the Trading System and shows how it works in a simulation (backtest). This adds significant value and is certainly incentivized!",
+            "updated": 1613588894036
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-002-how-to-contribute-icons.json

@@ -0,0 +1,138 @@
+{
+    "topic": "Contributing to Superalgos",
+    "pageNumber": "2",
+    "type": "How to Contribute Icons",
+    "definition": {
+        "text": "Superalgos' visual interface features hundreds of icons and many more icons are required with each release, as new functionality is rolled out. Designing icons is a great way to leave your mark, as it puts your work directly in front of every user!",
+        "updated": 1613590520324
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Attribution",
+            "updated": 1613378838786
+        },
+        {
+            "style": "Text",
+            "text": "The original set of icons is a web design pack made by Freepik and is available at:",
+            "updated": 1613378893975
+        },
+        {
+            "style": "Link",
+            "text": "flaticon.com->https://www.flaticon.com/packs/web-design-10?k=1596385749125",
+            "updated": 1613590565452
+        },
+        {
+            "style": "Text",
+            "text": "The rest of the series is inspired in the design style developed for the original set."
+        },
+        {
+            "style": "Text",
+            "text": "The authorship of each icon not in the original series may be tracked in the repository's history.",
+            "updated": 1613591688551
+        },
+        {
+            "style": "Title",
+            "text": "Coordination",
+            "updated": 1613591702695
+        },
+        {
+            "style": "Text",
+            "text": "Join the following group to coordinate works:",
+            "updated": 1613591754190
+        },
+        {
+            "style": "Link",
+            "text": "UX/UI Design Group->https://t.me/superalgosuxui",
+            "updated": 1613591786900
+        },
+        {
+            "style": "Text",
+            "text": "Please, introduce yourself and get up to speed with the group currently doing the work. The main coordination task is keeping track of who will block what part of the pending work so that we don’t duplicate efforts.",
+            "updated": 1613591821097
+        },
+        {
+            "style": "Title",
+            "text": "Design Brief",
+            "updated": 1613591872004
+        },
+        {
+            "style": "Subtitle",
+            "text": "Color Palette"
+        },
+        {
+            "style": "Text",
+            "text": "We use a restricted palette, with a playful selection of colors that work well both over a black background—on the Design Space — and a white background — on the Docs and the Charting Space.",
+            "updated": 1613591919434
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/icons/color-palette.png",
+            "updated": 1613593161363
+        },
+        {
+            "style": "Subtitle",
+            "text": "Look & Feel",
+            "updated": 1613592080753
+        },
+        {
+            "style": "Text",
+            "text": "Superalgos is a large and rather complex system aimed at all sorts of user profiles. The ultimate goal of the project is to massify the use of the system, thus, Superalgos should be accessible to a wide user base: from professional traders to crypto-holders, and everything in between."
+        },
+        {
+            "style": "Text",
+            "text": "The choice of a playful look and feel responds to the underlying strategy to achieve massification: to gamify the user experience, in the sense that building profitable trading strategies may be turned into a strategy game in and of itself."
+        },
+        {
+            "style": "Text",
+            "text": "We choose to depart from realistic or corporate styles and lean towards cartoonish, joyful, and spirited ideas instead."
+        },
+        {
+            "style": "Subtitle",
+            "text": "What we Like"
+        },
+        {
+            "style": "Text",
+            "text": "The following are examples of icons we like among the existing batch.",
+            "updated": 1613592138585
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/icons/charting-space.png",
+            "updated": 1613593154029
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/icons/data-mine.png",
+            "updated": 1613593146958
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/icons/crypto-exchange.png",
+            "updated": 1613593140143
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/icons/record-property.png",
+            "updated": 1613593120600
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
+        {
+            "style": "Png",
+            "text": "PNGs/Superalgos/Docs/icons/trigger-on.png",
+            "updated": 1613593129947
+        },
+        {
+            "style": "Title",
+            "text": "Work In Progress!!",
+            "updated": 1613593207724
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-002-icons-design-brief.json

@@ -0,0 +1,42 @@
+{
+    "topic": "Contributing to Superalgos",
+    "pageNumber": "2",
+    "type": "How to Contribute Icons",
+    "definition": {
+        "text": "Superalgos visual interface features hundreds of icons and many more icons are required with each release, as new functionality is rolled out. Designing icons is a great way to leave your mark, as it puts your work directly in front of every user!",
+        "updated": 1613378806864
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Attribution",
+            "updated": 1613378838786
+        },
+        {
+            "style": "Text",
+            "text": "The original set of icons is a web design pack made by Freepik and is available at:",
+            "updated": 1613378893975
+        },
+        {
+            "style": "Link",
+            "text": "flaticon.com https://www.flaticon.com/packs/web-design-10?k=1596385749125",
+            "updated": 1613378913044
+        },
+        {
+            "style": "Text",
+            "text": "The rest of the series is inspired in the design style developed for the original set."
+        },
+        {
+            "style": "Text",
+            "text": "The authorship of each icon not in the original series is indicated by the contributor’s identity in the Graphics repository."
+        },
+        {
+            "style": "Text",
+            "text": "asdf"
+        },
+        {
+            "style": "Text",
+            "text": "asdf"
+        }
+    ]
+}