Welcome tutorial WIP

2021-01-15 21:50:14 +01:00
1 parent 36d3812557
commit 937b51cfea
@@ -33,8 +33,8 @@
        },
        {
            "style": "Javascript",
-            "text": "docs.contribute Typo corrected.",
-            "updated": 1609943773867
+            "text": "docs.contribute Fixed typo.",
+            "updated": 1610742512175
        },
        {
            "style": "Title",
@@ -0,0 +1,58 @@
+{
+    "topic": "Feedback Loop",
+    "pageNumber": "1",
+    "type": "User Feedback",
+    "definition": {
+        "text": "Superalgos is a Community project! We make the software available to everyone free-of-charge, but we do ask for something in return... your help!",
+        "updated": 1610660537960
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "How Can Superalgos Be Free For Everyone?",
+            "updated": 1610658497040
+        },
+        {
+            "style": "Text",
+            "text": "That is a question we get all the time."
+        },
+        {
+            "style": "Text",
+            "text": "The project started with a group of friends joining forces to automate their crypto trading. They realized early on that—for trading intelligence to emerge—a huge software infrastructure was required. They knew that to compete with top market players on a level field, the system needed to be on par or better than commercial and proprietary software available to firms. Such requirements could not be fulfilled by a small team in a reasonable timeframe.",
+            "updated": 1610661121217
+        },
+        {
+            "style": "Important",
+            "text": "Superalgos is free for everyone because we want your help. We want to attract the best minds in the space, so that—together—we may build the ultimate trading automation platform.",
+            "updated": 1610660913324
+        },
+        {
+            "style": "Title",
+            "text": "Your First Contribution Is Your Feedback!",
+            "updated": 1610660067417
+        },
+        {
+            "style": "Text",
+            "text": "You just spent an hour or two discovering Superalgos. We want to have your first impression. We want to know what you think! And we want your initial feedback to be the first of many contributions to the project.",
+            "updated": 1610660053317
+        },
+        {
+            "style": "Callout",
+            "text": "You don't need to be a star programmer or professional trader to contribute. Superalgos is about fostering global collaboration and every user is expected to give back. Feedback is valuable. Fixing a typo is valuable. Translating a tutorial is valuable. Producing educational, reporting and removing bugs, contributing an indicator or a trading system, integrating a crypto project... everything is of great value!",
+            "updated": 1610662378411
+        },
+        {
+            "style": "Success",
+            "text": "To get started with your first contribution, keep going with the tutorial until the end. You will learn a few tricks that will make contributing a breeze!",
+            "updated": 1610660489943
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ]
+}
@@ -12,7 +12,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "With upcoming Beta 8, you will be able to train a new type of Learning Bot running a reinforcement learning algorithm! You will feed the bot with data mined from any source, and the learning process will output a policy file describing how to make decisions."
+            "text": "With upcoming versions of Superalgos, you will be able to train a new type of Learning Bot running a reinforcement learning algorithm! You will feed the bot with data mined from any source, and the learning process will output a policy file describing how to make decisions.",
+            "updated": 1610711392539
        },
        {
            "style": "Callout",
@@ -4,19 +4,21 @@
    "type": "Tutorial Step - What's Next?",
    "definition": {
        "icon": {
-            "project": "Superalgos",
-            "name": "bullet-info"
+            "name": "help",
+            "project": "Superalgos"
        },
        "text": "There are tons of things we haven't covered yet, I know! Just look around! So much stuff to see! It's mind-boggling."
    },
    "paragraphs": [
        {
            "style": "Text",
-            "text": "I'm sure you still have tons of questions floating in your head... How do I build my own strategies? How do I measure performance? How do I build an indicator? How do I deploy a trading farm? How may I integrate with TradingView? How do I set up Telegram announcements? Don't worry! You'll get there my friend... you'll just have to do some reading!"
+            "text": "I'm sure you still have tons of questions floating in your head... How do I build my own strategies? How do I measure performance? How do I build an indicator? How do I deploy a trading farm? How may I integrate with TradingView? How do I set up Telegram announcements?",
+            "updated": 1610711099627
        },
        {
            "style": "Success",
-            "text": "In the meantime, remember to stop your live session and data mining when you no longer need them running, and especially before closing the Client."
+            "text": "Don't worry! You'll get there my friend! There are more tutorials and a lot of reading material available! But before we get there, allow me a bit of gossiping... I got this from the Develop group too!",
+            "updated": 1610712307704
        }
    ]
 }
@@ -12,7 +12,8 @@
    "paragraphs": [
        {
            "style": "Text",
-            "text": "What does integrating Ethereum means, you ask? It means that&mdash;with Beta 8&mdash;you will be able to:"
+            "text": "What does integrating Ethereum mean, you ask? It means that—in future versions—you will be able to:",
+            "updated": 1610719381268
        },
        {
            "style": "List",
@@ -0,0 +1,30 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "108",
+    "type": "Tutorial Step - Three Minutes to Play",
+    "definition": {
+        "text": "I'll give you a few minutes to play around with your live session, and when you are ready, we'll move on to other things!",
+        "icon": {
+            "name": "live-trading-session",
+            "project": "Superalgos"
+        },
+        "updated": 1610647035525
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Take some time to process what you've learned so far...",
+            "updated": 1610647327253
+        },
+        {
+            "style": "Important",
+            "text": "Once you are ready to move on, feel free to stop the Live Trading Session and Data Tasks. You may leave the session running if you wish, but I wouldn't trust my hard-earned cash to the demo strategy indefinitely!",
+            "updated": 1610647503331
+        },
+        {
+            "style": "Success",
+            "text": "There's still a few more things I want to show you before I let you go! Bear with me!",
+            "updated": 1610711032226
+        }
+    ]
+}
@@ -0,0 +1,34 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "109",
+    "type": "Tutorial Step - Back to Work!",
+    "definition": {
+        "text": "Superalgos features an in-app, editable, and multi-language documentation site, and a built-in command line! Learn to use those and you'll be the king of the hill!",
+        "updated": 1610648506240,
+        "icon": {
+            "name": "status-dependency",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "You've already used a couple of documentation pages on the docs panel on the right, but that's just the tip of the iceberg!",
+            "updated": 1610651488454
+        },
+        {
+            "style": "Callout",
+            "text": "Let's try it! Search for the word... network.",
+            "updated": 1610648926126
+        },
+        {
+            "style": "Success",
+            "text": "Not to brag, but the speed of the search engine rivals the likes of Google ;-)",
+            "updated": 1610651624723
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ]
+}
@@ -0,0 +1,63 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "110",
+    "type": "Tutorial Step - Tabbed Search Results",
+    "definition": {
+        "text": "Results are organized in several categories, and each category is represented by a tab grouping results matching the category...",
+        "updated": 1610652285058,
+        "icon": {
+            "name": "dataset",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "I'll explain each briefly and set you free to look around:",
+            "updated": 1610712854590
+        },
+        {
+            "style": "List",
+            "text": "All: features results from all categories."
+        },
+        {
+            "style": "List",
+            "text": "Nodes: definitions of matching types of nodes.",
+            "updated": 1610712962218
+        },
+        {
+            "style": "List",
+            "text": "Concepts: includes notions such as References.",
+            "updated": 1610712970644
+        },
+        {
+            "style": "List",
+            "text": "Topics: large themes covered in sequenced pages.",
+            "updated": 1610712670894
+        },
+        {
+            "style": "List",
+            "text": "Tutorials: features the pages that make up tutorials.",
+            "updated": 1610652329836
+        },
+        {
+            "style": "List",
+            "text": "Reviews: features users reviews on plugins , etc...",
+            "updated": 1610712626605
+        },
+        {
+            "style": "List",
+            "text": "Books: collections of topics organized in chapters that cover entire app domains, for an orderly read.",
+            "updated": 1610712723851
+        },
+        {
+            "style": "List",
+            "text": "Workspace: returns nodes that are present in the active workspace... click to go to them!",
+            "updated": 1610713053382
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ]
+}
@@ -0,0 +1,35 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "111",
+    "type": "Tutorial Step - You Are In Command",
+    "definition": {
+        "text": "The search box, my friend, has a double life. Sometimes she searches, but other times she commands, and does stuff... whatever you tell her!",
+        "updated": 1610657116033,
+        "icon": {
+            "name": "strategy-manage-stage",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Not just anything, of course. There's a list of available commands that have to do with two main subjects:",
+            "updated": 1610704166915
+        },
+        {
+            "style": "List",
+            "text": "Producing and editing the Documentation.",
+            "updated": 1610719727338
+        },
+        {
+            "style": "List",
+            "text": "Contributing work to the project.",
+            "updated": 1610657381257
+        },
+        {
+            "style": "Callout",
+            "text": "Let's work on a practical example that involves the two! I'll set up the next few steps with a little story... I hope you like the idea!",
+            "updated": 1610713219293
+        }
+    ]
+}
@@ -0,0 +1,30 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "112",
+    "type": "Tutorial Step - Free For Everyone?",
+    "definition": {
+        "text": "Superalgos is a Community project! We make the software available to everyone free-of-charge, but we do ask for something in return... your help!",
+        "updated": 1610713937383,
+        "icon": {
+            "name": "help",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "List",
+            "text": "How can Superalgos be free? What's the catch?",
+            "updated": 1610714200780
+        },
+        {
+            "style": "Success",
+            "text": "We get those questions often! The story is...",
+            "updated": 1610714454438
+        },
+        {
+            "style": "Text",
+            "text": "Superalgos started with a group of friends joining forces to automate their crypto trading. They realized early on that to compete with top market players on a level field, a huge software infrastructure was required. The system needed to be on par or better than commercial and proprietary software available to firms. Such requirements could not be fulfilled by a small team in a reasonable timeframe.",
+            "updated": 1610719794658
+        }
+    ]
+}
@@ -0,0 +1,29 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "113",
+    "type": "Tutorial Step - A Brilliant Idea",
+    "definition": {
+        "text": "Superalgos is free for everyone because we want your help! We want the best minds in the space to help us build the ultimate trading automation platform!",
+        "icon": {
+            "name": "nodes-highlights",
+            "project": "Superalgos"
+        },
+        "updated": 1610719931963
+    },
+    "paragraphs": [
+        {
+            "style": "Callout",
+            "text": "Your first contribution is your feedback!",
+            "updated": 1610715230137
+        },
+        {
+            "style": "Text",
+            "text": "You just spent an hour or two discovering Superalgos. We want to have your first impression. We want to know what you think! And we want your initial feedback to be the first of many contributions to the project."
+        },
+        {
+            "style": "Success",
+            "text": "You don't need to be a star programmer or professional trader to contribute. Every user is expected to give back!",
+            "updated": 1610715439365
+        }
+    ]
+}
@@ -0,0 +1,54 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "114",
+    "type": "Tutorial Step - What is a Contribution?",
+    "definition": {
+        "text": "Superalgos is about fostering global collaboration. We welcome contributions of all sorts so that everyone may give back!",
+        "icon": {
+            "name": "execution-algorithm",
+            "project": "Superalgos"
+        },
+        "updated": 1610715826372
+    },
+    "paragraphs": [
+        {
+            "style": "Success",
+            "text": "In short, everything that adds value!",
+            "updated": 1610716879897
+        },
+        {
+            "style": "List",
+            "text": "Fixing a typo, a dead link, and improving the docs.",
+            "updated": 1610716935723
+        },
+        {
+            "style": "List",
+            "text": "Translating a page into your native language.",
+            "updated": 1610715988366
+        },
+        {
+            "style": "List",
+            "text": "Designing icons, working to improve the UX/UI."
+        },
+        {
+            "style": "List",
+            "text": "Producing content as in-app tutorials or videos.",
+            "updated": 1610716958990
+        },
+        {
+            "style": "List",
+            "text": "Blogging about Superalgos and spreading the word.",
+            "updated": 1610717040985
+        },
+        {
+            "style": "List",
+            "text": "Sharing a Data Mine or a Trading System!",
+            "updated": 1610716257080
+        },
+        {
+            "style": "List",
+            "text": "Testing, removing bugs, integrating crypto-projects, and contributing to the Code Base.",
+            "updated": 1610716390346
+        }
+    ]
+}
@@ -0,0 +1,29 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "115",
+    "type": "Tutorial Step - What About Free Riders?",
+    "definition": {
+        "text": "Free riders are a problem, but—for the time being—we choose to assume goodwill! The ball is on your side of the court!",
+        "updated": 1610718496947,
+        "icon": {
+            "name": "bullet-error",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "The project will soon implement an incentives scheme to further promote the desired behavior and to foster the culture of collaboration.",
+            "updated": 1610720058284
+        },
+        {
+            "style": "Important",
+            "text": "This means that our first choice to deal with free-riding is the positive route. However, we do not overrule the possibility of establishing negative incentives in the future.",
+            "updated": 1610718992014
+        },
+        {
+            "style": "Callout",
+            "text": "Are you ready to hit that ball? Let's get on with it!"
+        }
+    ]
+}
@@ -0,0 +1,44 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "116",
+    "type": "Tutorial Step - Let's Add Your Review!",
+    "definition": {
+        "text": "In this step, you are going to run your first command to create a review page! This page will be yours to edit in the future too!",
+        "updated": 1610720363593,
+        "icon": {
+            "name": "expand",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "The syntax to write commands is quite colloquial! You'll love it! Check it out and follow the instructions below!",
+            "updated": 1610730420596
+        },
+        {
+            "style": "Javascript",
+            "text": "docs.add Review to Superalgos: Superalgos Project Review->Superalgos Review - YOUR REVIEW TITLE"
+        },
+        {
+            "style": "List",
+            "text": "FIRST: Copy the above command",
+            "updated": 1610721087742
+        },
+        {
+            "style": "List",
+            "text": "SECOND: Paste it on a text editor.",
+            "updated": 1610721128275
+        },
+        {
+            "style": "List",
+            "text": "THIRD: Replace YOUR REVIEW TITLE with a meaningful title for your review.",
+            "updated": 1610721106177
+        },
+        {
+            "style": "List",
+            "text": "FOURTH: Paste the updated command on the search/command box and click Enter.",
+            "updated": 1610736916242
+        }
+    ]
+}
@@ -0,0 +1,39 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "117",
+    "type": "Tutorial Step - Did It Work?",
+    "definition": {
+        "text": "If you didn't mess up the command, you should be seeing a new page with the title you set, an invitation to write a summary, and more below!",
+        "icon": {
+            "name": "docs-action-edit-paragraph",
+            "project": "Superalgos"
+        },
+        "updated": 1610731827383
+    },
+    "paragraphs": [
+        {
+            "style": "Note",
+            "text": "If you are getting an error message, read it and fix the problem! It's likely about the syntax in the command. Remember you may always go back a step to recover the original command!",
+            "updated": 1610732596680
+        },
+        {
+            "style": "List",
+            "text": "Right-click and select the pencil icon to edit.",
+            "updated": 1610732029994
+        },
+        {
+            "style": "List",
+            "text": "To exit edit mode, click the Escape key."
+        },
+        {
+            "style": "List",
+            "text": "To add new paragraphs, edit the last one, click Enter and keep writing. See what happens when you exit!",
+            "updated": 1610732334559
+        },
+        {
+            "style": "List",
+            "text": "To change styles, right-click and explore the menu!",
+            "updated": 1610732414111
+        }
+    ]
+}
@@ -0,0 +1,25 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "118",
+    "type": "Tutorial Step - Don't Forget to Sign!",
+    "definition": {
+        "text": "These comments about your first impressions on Superalgos are your first contribution, and for that we thank you!",
+        "updated": 1610735268141,
+        "icon": {
+            "name": "bullet-warning",
+            "project": "Superalgos"
+        }
+    },
+    "paragraphs": [
+        {
+            "style": "Important",
+            "text": "For your review to be merged in the Superalgos repository, you must sign it with your GitHub.com user name in the last paragraph of the page! This is important so that you may later find the page using the search! As you progress with Superalgos, you may always come back and edit it.",
+            "updated": 1610734914493
+        },
+        {
+            "style": "Note",
+            "text": "Contributions are subject to the terms of the <a href=\"https://github.com/Superalgos/Superalgos/blob/master/LICENSE\" target=\"_blank\">Apache Licence 2.0</a>. In short, Contributors provide an express grant of copyright/patent rights.",
+            "updated": 1610735233965
+        }
+    ]
+}
@@ -0,0 +1,29 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "119",
+    "type": "Tutorial Step - Don't Forget to Save!",
+    "definition": {
+        "text": "Before you get to a novel-length kind of write-up, make sure you save the page every once in a while! No need to risk your prose!",
+        "icon": {
+            "name": "under-construction",
+            "project": "Superalgos"
+        },
+        "updated": 1610736735029
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Each paragraph you write is stored at the level of the browser's session as soon as you exit Edit mode. However, to save the page on disk and avoid losing work on an eventual browser crash, run this command:",
+            "updated": 1610737846767
+        },
+        {
+            "style": "Javascript",
+            "text": "docs.save"
+        },
+        {
+            "style": "Success",
+            "text": "You may run the command as many times as you wish. If for any reason you loose sight of the page, run the docs.reindex command and search for the title you used while adding it!",
+            "updated": 1610737763346
+        }
+    ]
+}
@@ -0,0 +1,40 @@
+{
+    "tutorial": "Welcome to Superalgos!",
+    "pageNumber": "120",
+    "type": "Tutorial Step - Get Ready to Push!",
+    "definition": {
+        "text": "Amazing! You learned to add a page to the Docs, edit it, and save it! Now you've got to make it transcend your PC and contribute it to Superalgos!",
+        "icon": {
+            "name": "github",
+            "project": "Superalgos"
+        },
+        "updated": 1610738103790
+    },
+    "paragraphs": [
+        {
+            "style": "Text",
+            "text": "Superalgos interacts with Git to keep your Superalgos instalation up to date and to make contributions easier for less technical users. The App Contribute Command runs the following Git commands in a sequence:",
+            "updated": 1610743150715
+        },
+        {
+            "style": "List",
+            "text": "git.add: adds the changes you've made to contributable files to a git commit.",
+            "updated": 1610743268237
+        },
+        {
+            "style": "List",
+            "text": "git.commit: commits all the changes.",
+            "updated": 1610743294792
+        },
+        {
+            "style": "List",
+            "text": "git.push: pushes the changes to your fork.",
+            "updated": 1610743337006
+        },
+        {
+            "style": "List",
+            "text": "github.createPullRequest: creates a Pull Request at the Superalgos repository, or add commits to an existing Pull Request.",
+            "updated": 1610743396382
+        }
+    ]
+}