From cf5eb1f3327d6ebc7d17d66b120615dc84eaa17b Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Wed, 5 May 2021 09:15:00 +0200 Subject: [PATCH 1/2] Tutorials --- ...algos-006-how-to-contribute-tutorials.json | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-006-how-to-contribute-tutorials.json b/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-006-how-to-contribute-tutorials.json index b205fca85..ace3330c3 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-006-how-to-contribute-tutorials.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/contributing-to-superalgos-006-how-to-contribute-tutorials.json @@ -401,6 +401,39 @@ "text": "Always use a grammar and spell-checker to make sure your tutorial is as correct as it may be!", "updated": 1617734220351 }, + { + "style": "Title", + "text": "The First Few Steps", + "updated": 1620198004607 + }, + { + "style": "List", + "text": "Tutorials should start with a welcome message, and a clear explanation of what the tutorial is about, including a brief description of what the user will do while following the tutorial, and what lessons will be learned. No need to compress everything into a single step... two and even three steps are fine.", + "updated": 1620198631200 + }, + { + "style": "List", + "text": "You should also take the time to explain what's featured in the Workspace. The idea is that users should get familiar with the workspace as soon as possible, to understand how it may differ from other workspaces they may have encountered earlier. You can mention which mines you will use, clarify if they are added as plugins or not, which trading systems, and so on. You may skip the mandatory hierarchies, like Network or Trading Engine.", + "updated": 1620198644147 + }, + { + "style": "List", + "text": "If you installed any markets, created custom charts, a particular setup of tasks in the Network hierarchy, or any specific data structure that is not present in the default market installation, make sure you explain what you did and why. It may be confusing for users to find things and not know how they got there.", + "updated": 1620198654823 + }, + { + "style": "Title", + "text": "The Last Few Steps" + }, + { + "style": "List", + "text": "If there are more tutorials in the series, make sure you leave users right by the next one, inviting them to keep going." + }, + { + "style": "List", + "text": "If the remaining tutorials in the series are not ready yet, then use the last few steps to describe what else will be covered in the series and ask users to stay tuned.", + "updated": 1620198840899 + }, { "style": "Text", "text": "" From 6b10ea126d9b20b73f0fd1902359be8a4a4e2286 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Wed, 5 May 2021 12:10:34 +0200 Subject: [PATCH 2/2] Charting space tutorial typos --- ...set-up-a-new-chart-008-tutorial-step-your-first-chart.json | 4 ++-- ...to-set-up-a-new-chart-014-tutorial-step-naming-charts.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-008-tutorial-step-your-first-chart.json b/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-008-tutorial-step-your-first-chart.json index 86d963f47..9206bf09d 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-008-tutorial-step-your-first-chart.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-008-tutorial-step-your-first-chart.json @@ -3,12 +3,12 @@ "pageNumber": 8, "type": "Tutorial Step - Your First Chart", "definition": { - "text": "This tutorial will help you set up your first custom Chart. The foundational concepts you learn here will help you make the most out of Superalgo’s Charting Space.", + "text": "This tutorial will help you set up your first custom Chart. The foundational concepts you learn here will help you make the most out of the Charting Space.", "icon": { "name": "chart-points", "project": "Superalgos" }, - "updated": 1619016455188 + "updated": 1620203198895 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-014-tutorial-step-naming-charts.json b/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-014-tutorial-step-naming-charts.json index 6b4025e79..220dcc881 100644 --- a/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-014-tutorial-step-naming-charts.json +++ b/Projects/Superalgos/Schemas/Docs-Tutorials/how-to-set-up-a-new-chart-014-tutorial-step-naming-charts.json @@ -13,8 +13,8 @@ "paragraphs": [ { "style": "Text", - "text": "Make sure to name Dashboards with something you will recognize. A good naming practice is to reference the type of environment (live trading, backtesting, etc.) and network name. For us that would be:", - "updated": 1620009736665 + "text": "Make sure to name Dashboards with something you will recognize. A good naming practice is to reference the type of environment (live trading, backtesting, etc.) and Network Node name. For us that would be:", + "updated": 1620208459743 }, { "style": "Json",