Tutorial tips update
This commit is contained in:
Julian Molina committed
1 parent
c0a74025ff
commit
45a768c9c5
17 files changed
+63
-38
No files matched your search
+27
-4
@@ -29,8 +29,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "When you build a tutorial for Superalgos, you become the maintainer of the tutorial. It is your responsibility to keep the tutorial up to date with the system, and to implement the feedback users may share! Your tutorial must become the ultimate resource to learn the topics it covers.",
|
||||
"updated": 1617712109958
|
||||
"text": "When you build a tutorial for Superalgos, you become the maintainer of the tutorial. It is your responsibility to keep the tutorial up to date with the system, and to implement the feedback users may share! Your tutorial must become the ultimate resource to learn the topics it covers. ",
|
||||
"updated": 1620645983606
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
@@ -118,8 +118,26 @@
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Consistent Use of Space and Styles",
|
||||
"updated": 1617904223037
|
||||
"text": "Use Precise Language",
|
||||
"updated": 1620645613169
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The ultimate goal of tutorials is to provide users with a hands-on learning experience covering topics in detail. In general terms, we know that a tutorial is good — or has reached a mature state — when users ask no questions about it in the Support Group.",
|
||||
"updated": 1620645730740
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Be precise and unequivocal with language. Read your writing over and over in search of phrases that may not be easily understood, or that may be interpreted in different ways. Improve the sentences to make them as clear as possible. Remember, the less clear your writing is, the more questions we have in the Support Group.",
|
||||
"updated": 1620645812565
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "Be prepared to iterate over and over until the tutorial stabilizes. That will happen when there are no more questions about the topic in the Support Group!"
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Consistent Use of Space and Styles"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
@@ -330,6 +348,11 @@
|
||||
"text": "Do not set two consecutive paragraphs with the same style. The only exception is for bullet lists. Even the Docs Text Style is not formated to look good as consecutive paragraphs in the context of a tutorial (there is no padding between paragraphs).",
|
||||
"updated": 1617723650896
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Leave at least one line empty before the buttons at the bottom of the tutorial window. Otherwise, in other browsers, the content may overflow the window.",
|
||||
"updated": 1620646218773
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Titles"
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "right-click to open the map for a birds eye view of the workspace.",
|
||||
"updated": 1620049276538
|
||||
"text": "Right-click to open the Design Space map for a birds eye view of the workspace.",
|
||||
"updated": 1620553531060
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -22,8 +22,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "left-click to zoom back into the workspace.",
|
||||
"updated": 1620049288666
|
||||
"text": "Left-click to zoom back into the workspace.",
|
||||
"updated": 1620553577819
|
||||
}
|
||||
]
|
||||
}
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "As you may remember from Install a New Market Tutorial, installing a market sets up everything you need for a basic Superalgos workspace. This includes automatically setting up a Backtesting Session, Live Trading Session, and charts for each Trading System present in the workspace.",
|
||||
"updated": 1620005481411
|
||||
"text": "The Install a New Market Tutorial taught you that installing a market sets up everything you need for a basic Superalgos workspace. This includes automatically setting up a Backtesting Session, a Live Trading Session, and charts for each Trading System present in the workspace.",
|
||||
"updated": 1620553824986
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Eventually Dashboards will be used to bring multiple Time Machines together in useful configurations within the Charting Space. Think of multiple charts configured in intricate side by side displays! But for right now they helps us stay organized.",
|
||||
"updated": 1620007944527
|
||||
"text": "Eventually Dashboards will be used to bring multiple Time Machines together in useful configurations within the Charting Space. Think of multiple charts configured in intricate side by side displays! But for right now, they help us stay organized.",
|
||||
"updated": 1620554034465
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
|
||||
+4
-4
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 14,
|
||||
"type": "Tutorial Step - Add a Time Machine",
|
||||
"definition": {
|
||||
"text": "Look at you go! You are making great progress. Now lets get that Time Machine added!",
|
||||
"updated": 1620260972485,
|
||||
"text": "Look at you! You are making great progress. Now lets get that Time Machine added!",
|
||||
"updated": 1620554388969,
|
||||
"icon": {
|
||||
"name": "chart-points",
|
||||
"project": "Superalgos"
|
||||
@@ -27,8 +27,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Other helpful information you can use to label your charts can include the exchange, market pair, and network node associated with the information shown in the chart.",
|
||||
"updated": 1620261780042
|
||||
"text": "Other helpful information you can use to label your charts can include the exchange, market pair, and network node associated with the information featured.",
|
||||
"updated": 1620554455184
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-1
@@ -13,7 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "These are the scales! Anytime you add a time machine, it will come equipped with three scales (Rate, Time, and Time Frame). These are the same scales you have used to interact with charts in the Charting Space."
|
||||
"text": "These are the scales! Anytime you add a time machine, it will come equipped with three scales (Rate Scale, Time Scale, and Time Frame Scale). These are the same scales you have used to interact with charts in the Charting Space.",
|
||||
"updated": 1620554514514
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
|
||||
+4
-4
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 16,
|
||||
"type": "Tutorial Step - Chart Spawning",
|
||||
"definition": {
|
||||
"text": "One thing to keep in mind when adding Time Machines is that they will often spawn on top of other charts within the Charting Space.",
|
||||
"updated": 1620045784065,
|
||||
"text": "One thing to keep in mind when adding Time Machines is that they may spawn on top of other charts within the Charting Space.",
|
||||
"updated": 1620554644805,
|
||||
"icon": {
|
||||
"name": "mouse-left-click",
|
||||
"project": "Superalgos"
|
||||
@@ -18,8 +18,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Move the time machines around and look for the title you added to your time machine in the Design Space.",
|
||||
"updated": 1620264649926
|
||||
"text": "If necessary, move the time machines around and look for the title you added to your time machine in the Design Space.",
|
||||
"updated": 1620554665332
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -28,8 +28,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Make sure your title is short enough to fit within the label box! You'll see why soon.",
|
||||
"updated": 1620265202668
|
||||
"text": "Make sure your title is short! You'll see why soon.",
|
||||
"updated": 1620554841489
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -28,8 +28,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "A Layer Manager's name is inherited from its Timeline Chart. As you can see, your naming Matters!",
|
||||
"updated": 1620047088154
|
||||
"text": "A Layer Manager inherits the name from its Timeline Chart. That's why a short name was best!",
|
||||
"updated": 1620555102768
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -22,8 +22,8 @@
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Trading Mine Products– for results of a trading system’s Backtesting Session or Live Trading Session.",
|
||||
"updated": 1617641005190
|
||||
"text": "Trading Mine Products – for results of trading sessions.",
|
||||
"updated": 1620555233360
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
|
||||
+2
-2
@@ -18,8 +18,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Did you find them? Keep going farther down the hierarchy until you see them!",
|
||||
"updated": 1617849595158
|
||||
"text": "Did you find it? Keep going farther down the hierarchy until you see them!",
|
||||
"updated": 1620555757952
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -18,8 +18,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Pin and drag your whole Time Machine over to the Data Mine Products nodes you found earlier.",
|
||||
"updated": 1620047379533
|
||||
"text": "Find your way to the Time Machine you created earlier, pin it, collapse it, and drag it over to the Data Mine Products nodes you found on the previous step.",
|
||||
"updated": 1620555518613
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
|
||||
+2
-1
@@ -18,7 +18,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Find the Layer Manager under the Timeline Chart you added earlier. Then establish a reference between it and the Masters Data Mine Products node."
|
||||
"text": "Find the Layer Manager under the Timeline Chart you added earlier. Then establish a reference from it to the Masters Data Mine Products node.",
|
||||
"updated": 1620556116868
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "The last step is to hover over the Layer Manager and click Add All Mine Layers. ",
|
||||
"updated": 1617850457047
|
||||
"text": "The last step is to hover over the Layer Manager and click Add All Mine Layers. Make sure you confirm after you click the button!",
|
||||
"updated": 1620556206237
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Take a few minutes and check between the Bot Products nodes and your Layers. They Match!",
|
||||
"updated": 1620048480506
|
||||
"text": "Take a few minutes and check between the Bot Products offspring nodes and your new layers. They Match!",
|
||||
"updated": 1620559042193
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The next thing you will want to connect with most charts are the results of your trading strategies. For the most part, this is the same as connecting to a Data Mine. There are just a few differences I will walk you through. One major difference is that each Time Machine can only reference one Trading Session. For example, one Backtesting Session that is associated with one Trading System. This helps keep your charts clean and readable. It would be confusing to see buy orders from two different trading systems all at once! What this means for connecting a chart is that we need to establish two references in order for things to work.",
|
||||
"updated": 1617851405458
|
||||
"text": "The next thing you will want to connect with most charts are the results of your trading sessions. For the most part, this is the same as connecting to a Data Mine. There are just a few differences I will walk you through. One major difference is that each Time Machine can only reference one Trading Session. For example, one Backtesting Session that is associated with one Trading System. This helps keep your charts clean and readable. It would be confusing to see buy orders from two different trading systems all at once! What this means for connecting a chart is that we need to establish two references in order for things to work.",
|
||||
"updated": 1620560071262
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user