Merge pull request #399 from julian-molina/develop

Contribution: Docs messages

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-001-docs-help-command.json

@@ -3,8 +3,8 @@
     "pageNumber": "1",
     "type": "Docs Help Command",
     "definition": {
-        "text": "The Docs provide a command line interface that users can use to contribute to the Docs. The Docs Help Command provides a list of all available commands at any given Superalgos version.",
-        "updated": 1609140843415
+        "text": "The Docs provide a command line interface that you may use to contribute to the Docs. The Docs Help Command provides a list of all available commands.",
+        "updated": 1610974835590
     },
     "paragraphs": [
         {
@@ -49,7 +49,8 @@
         },
         {
             "style": "Text",
-            "text": "Another way to use this command is by providing the name of another command you would like to see help info on."
+            "text": "Another way to use this command is to provide the name of a command for which you would like to see help info.",
+            "updated": 1610974898665
         },
         {
             "style": "Title",
@@ -73,8 +74,8 @@
         },
         {
             "style": "Note",
-            "text": " Anything you type at the command prompt not identified as a command will be treated as a search query.  ",
-            "updated": 1609150627730
+            "text": "Entries in the command prompt not identified as a command are treated as a search query.",
+            "updated": 1610974943826
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json

@@ -3,8 +3,8 @@
     "pageNumber": "2",
     "type": "Docs Goto Command",
     "definition": {
-        "text": "This command provides a mechanism to navigate to a Docs page or an specific anchor within a page.",
-        "updated": 1609141474363
+        "text": "This command provides a mechanism to navigate to a Docs page or an anchor within the page.",
+        "updated": 1610975620919
     },
     "paragraphs": [
         {
@@ -24,18 +24,18 @@
         },
         {
             "style": "List",
-            "text": "Project : Is the project where the Node, Concept or Topic is defined.",
-            "updated": 1609148511059
+            "text": "Project: It's the project where the Node, Concept, Topic, Tutorial or Review is defined.",
+            "updated": 1610975746510
         },
         {
             "style": "List",
-            "text": "Docs Page Category : Node, Concept or Topic.",
-            "updated": 1609148563484
+            "text": "Docs Page Category: Node, Concept, Topic, Tutorial or Review.",
+            "updated": 1610975692859
         },
         {
             "style": "List",
-            "text": "Docs Page Name : For Nodes it is the type of node, for Concepts, the concept name, for topics, the topic's page name.",
-            "updated": 1609149220268
+            "text": "Docs Page Name: For Nodes it is the type of node; for Concepts, the concept name; for Topics, the topic's page name, for Tutorials, the tutorial step name; for Reviews, the review page name.",
+            "updated": 1610975736116
         },
         {
             "style": "List",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json

@@ -20,7 +20,7 @@
         {
             "style": "Json",
             "text": "docs.add Node to Project: Docs Page Name",
-            "updated": 1609149799453
+            "updated": 1610975287652
         },
         {
             "style": "Subtitle",
@@ -29,7 +29,8 @@
         },
         {
             "style": "Json",
-            "text": "docs.add Node to Superalgos"
+            "text": "docs.add Node to Superalgos: Binance API",
+            "updated": 1610975052587
         },
         {
             "style": "Subtitle",
@@ -48,7 +49,8 @@
         },
         {
             "style": "Json",
-            "text": "docs.add Concept to Superalgos"
+            "text": "docs.add Concept to Superalgos: Two-way Reference",
+            "updated": 1610975077695
         },
         {
             "style": "Subtitle",
@@ -86,8 +88,8 @@
         },
         {
             "style": "Json",
-            "text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro",
-            "updated": 1610706570716
+            "text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro->1",
+            "updated": 1610975123605
         },
         {
             "style": "Subtitle",
@@ -96,8 +98,8 @@
         },
         {
             "style": "Json",
-            "text": "docs.add Review to Project: Docs Review Name->Docs Page Name->Docs Page Number",
-            "updated": 1610706722998
+            "text": "docs.add Review to Project: Docs Review Name->Docs Page Name",
+            "updated": 1610975148914
         },
         {
             "style": "Subtitle",
@@ -114,25 +116,28 @@
         },
         {
             "style": "List",
-            "text": "Project : Is the project where the Node, Concept or Topic is defined."
+            "text": "Project: It's the project where the Node, Concept, Topic or Review is defined.",
+            "updated": 1610975793026
         },
         {
             "style": "List",
-            "text": "Docs Page Category : Node, Concept or Topic."
+            "text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.",
+            "updated": 1610975177859
         },
         {
             "style": "List",
-            "text": "Docs Topic Name: The name of the topic which the new page will belong to.",
-            "updated": 1609149944222
+            "text": "Docs Topic / Tutorial / Review Name: The name of the topic /tutorial /review to which the new page will belong.",
+            "updated": 1610975248463
         },
         {
             "style": "List",
-            "text": "Docs Page Name : For Nodes it is the type of node, for Concepts, the concept name, for topics, the topic's page name."
+            "text": "Docs Page Name: For Nodes it is the type of node; for Concepts, the concept name; for Topics, the topic's page name, for Tutorials, the tutorial step name; for Reviews, the review page name.",
+            "updated": 1610975361761
         },
         {
             "style": "List",
-            "text": "Docs Page Numer: Optional. A page number that you would like to assing the new page. This will impact only at the position of the Topic Index. If you don't provide one, it will be automatically assigned the last page number in the collection plus 1.",
-            "updated": 1610706305834
+            "text": "Docs Page Numer: Optional. A page number to be assigned to the new page. The number affects the position in the corresponding table of contents only. If a Docs Page Number is not provided, the systems assign one.",
+            "updated": 1610975499631
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json

@@ -111,15 +111,17 @@
         },
         {
             "style": "List",
-            "text": "Project : Is the project where the Node, Concept or Topic is defined."
+            "text": "Project: It's the project where the Node, Concept, Topic or Review is defined.",
+            "updated": 1610975967746
         },
         {
             "style": "List",
-            "text": "Docs Page Category : Node, Concept or Topic."
+            "text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.",
+            "updated": 1610975936004
         },
         {
             "style": "List",
-            "text": "Docs Page Name : For Nodes it is the type of node, for Concepts, the concept name, for topics, the topic's page name."
+            "text": "Docs Page Name: For Nodes it is the type of node; for Concepts, the concept name; for Topics, the topic's page name, for Tutorials, the tutorial step name; for Reviews, the review page name."
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json

@@ -3,8 +3,8 @@
     "pageNumber": "5",
     "type": "Docs Save Command",
     "definition": {
-        "text": "Use this command to save the changes you have done while adding, deleting or editing paragraphs at the Docs; or adding or deleting pages. ",
-        "updated": 1609152030934
+        "text": "Use this command to save the changes you've made while adding, deleting or editing paragraphs at the Docs; or adding or deleting pages.",
+        "updated": 1610976014577
     },
     "paragraphs": [
         {

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-007-docs-repaginate-command.json

@@ -0,0 +1,44 @@
+{
+    "topic": "Docs Commands",
+    "pageNumber": "7",
+    "type": "Docs Repaginate Command",
+    "definition": {
+        "text": "When you add a Docs Topic Page or a Docs Tutorial Page, you may define a page number. The number defines the position of the page within the table of contents. To add a page in-between other pages you may use decimal values. Use the Repaginate command to recalculate all page numbers and leave the whole set in integers.",
+        "updated": 1610976158171
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Syntax",
+            "updated": 1610393031768
+        },
+        {
+            "style": "Javascript",
+            "text": "docs.repaginate Category from Project: Topic or Tutorial name."
+        },
+        {
+            "style": "Title",
+            "text": "Properties"
+        },
+        {
+            "style": "List",
+            "text": "Category: It must be either Topic or Tutorial."
+        },
+        {
+            "style": "List",
+            "text": "Project: Any existing already integrated project."
+        },
+        {
+            "style": "List",
+            "text": "Topic or Tutorial name: The name given tu the Topic or Tutorial that you want to repaginate."
+        },
+        {
+            "style": "Title",
+            "text": "Example"
+        },
+        {
+            "style": "Javascript",
+            "text": "docs.repaginate Topic from Superalgos: Docs Commands"
+        }
+    ]
+}

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-001-docs-error-intro.json

@@ -3,14 +3,14 @@
     "pageNumber": 1,
     "type": "Docs Error - Intro",
     "definition": {
-        "text": "While executing a command, you might receive different types of error messanges. These are described below. ",
-        "updated": 1609159174480
+        "text": "After running a command, you may get different types of error messages, as decribed in this topic.",
+        "updated": 1610976310255
     },
     "paragraphs": [
         {
             "style": "Text",
-            "text": "The previous is the complete list of errors you might find while executing Docs commands. In fact, once you get an error, you will be automatically sent to the error page.",
-            "updated": 1609175853003
+            "text": "The table of contents belos shows the complete list of errors you may get while running Docs commands. In fact, when an error occurs, you are redirected to the error page.",
+            "updated": 1610976413909
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-002-docs-error-too-few-parameters.json

@@ -3,8 +3,8 @@
     "pageNumber": 2,
     "type": "Docs Error - Too Few Parameters",
     "definition": {
-        "text": "While executing a command, you might receive different types of error messanges. These are described below. ",
-        "updated": 1609159174480
+        "text": "The system expects more parameters. This may happen when you effectively missed a parameter or when a syntax error breaks the command.",
+        "updated": 1610976595172
     },
     "paragraphs": [
         {
@@ -40,10 +40,6 @@
             "style": "List",
             "text": "Docs Delete Command"
         },
-        {
-            "style": "List",
-            "text": "Docs Delete Command"
-        },
         {
             "style": "List",
             "text": "Docs Repaginate Command"

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-003-docs-error-project-does-not-exist.json

@@ -3,8 +3,8 @@
     "pageNumber": 3,
     "type": "Docs Error - Project Does Not Exist",
     "definition": {
-        "text": "While executing a command, you might receive different types of error messanges. These are described below. ",
-        "updated": 1609159174480
+        "text": "You may have misspelled the name of the project.",
+        "updated": 1610976884761
     },
     "paragraphs": [
         {
@@ -13,12 +13,13 @@
         },
         {
             "style": "Error",
-            "text": "The Project you have specified, does not exist. ",
-            "updated": 1609160205674
+            "text": "The Project you have specified does not exist.",
+            "updated": 1610976906083
         },
         {
             "style": "Success",
-            "text": "Check that you typed the Project name correctly. Project names are key-sensitive."
+            "text": "Verify the Project name you typed. Project names are case-sensitive.",
+            "updated": 1610977145287
         },
         {
             "style": "Title",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-004-docs-error-category-not-valid.json

@@ -3,8 +3,8 @@
     "pageNumber": 4,
     "type": "Docs Error - Category Not Valid",
     "definition": {
-        "text": "While executing a command, you might receive different types of error messanges. These are described below. ",
-        "updated": 1609159174480
+        "text": "The category specified does not exist.",
+        "updated": 1610977115090
     },
     "paragraphs": [
         {
@@ -13,13 +13,13 @@
         },
         {
             "style": "Error",
-            "text": "The category you have specidied is not a valid Docs Page Category.",
-            "updated": 1609160924575
+            "text": "The category you have specified is not a valid Docs Page Category.",
+            "updated": 1610977123169
         },
         {
             "style": "Success",
-            "text": " Valid categories are: Node, Concept and Topic. This parameter is key-sensitive.",
-            "updated": 1609161108040
+            "text": "Valid categories are: Node, Concept, Topic, Tutorial and Review. This parameter is case-sensitive.",
+            "updated": 1610977087296
         },
         {
             "style": "Title",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-005-docs-error-page-not-found.json

@@ -3,8 +3,8 @@
     "pageNumber": 5,
     "type": "Docs Error - Page Not Found",
     "definition": {
-        "text": "While executing a command, you might receive different types of error messanges. These are described below. ",
-        "updated": 1609159174480
+        "text": "The page does not exist in the category specified.",
+        "updated": 1610977264289
     },
     "paragraphs": [
         {
@@ -13,7 +13,8 @@
         },
         {
             "style": "Error",
-            "text": "The Docs Page Name you have specified could not be found in the collection of pages of the Docs Page Category you provided."
+            "text": "The Docs Page Name you specified can not be found in the collection of pages of the Docs Page Category you provided.",
+            "updated": 1610977238380
         },
         {
             "style": "Success",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-006-docs-error-page-with-no-paragraphs.json

@@ -3,8 +3,8 @@
     "pageNumber": 6,
     "type": "Docs Error - Page With No Paragraphs",
     "definition": {
-        "text": "While executing a command, you might receive different types of error messanges. These are described below. ",
-        "updated": 1609159174480
+        "text": "The page exists but it's empty.",
+        "updated": 1610977367224
     },
     "paragraphs": [
         {
@@ -13,12 +13,13 @@
         },
         {
             "style": "Error",
-            "text": "The Docs Page Name you  specified was found, but it does not have any paragraphs in it. "
+            "text": "The Docs Page Name you specified was found, but it has no paragraphs in it.",
+            "updated": 1610977343685
         },
         {
             "style": "Success",
-            "text": "You need to fix this in order for you or others users to be able to use this command.",
-            "updated": 1609161948865
+            "text": "Please, help us fix this page!",
+            "updated": 1610977394319
         },
         {
             "style": "Title",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-007-docs-error-only-in-english.json

@@ -3,8 +3,8 @@
     "pageNumber": 7,
     "type": "Docs Error - Only In English",
     "definition": {
-        "text": "Command not available because you are not set in English language.",
-        "updated": 1609176264266
+        "text": "You may only use this command in the English version of the Docs.",
+        "updated": 1610977499324
     },
     "paragraphs": [
         {
@@ -14,12 +14,13 @@
         },
         {
             "style": "Error",
-            "text": "This command is available only while you are browsing the Docs in English language."
+            "text": "This command is available only while browsing the Docs in English language.",
+            "updated": 1610977476368
         },
         {
             "style": "Success",
-            "text": " Switch to English and try again.  ",
-            "updated": 1609176617797
+            "text": "Set English as your preferred language on the footer of this page and try again.",
+            "updated": 1610977454296
         },
         {
             "style": "Title",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-errors-008-docs-error-missing-colon.json

@@ -3,8 +3,8 @@
     "pageNumber": 8,
     "type": "Docs Error - Missing Colon",
     "definition": {
-        "text": "You forgot the colon character \":\" that is part of the syntax of the command. ",
-        "updated": 1609176951837
+        "text": "Make sure you are using the \":\" in the appropriate position.",
+        "updated": 1610977606831
     },
     "paragraphs": [
         {
@@ -19,8 +19,8 @@
         },
         {
             "style": "Success",
-            "text": "   Check the syntax of the command you are executing and see where to place the colon \":\" character.  The character might not be detected if a space is not following it.    ",
-            "updated": 1609230445669
+            "text": "Check the syntax of the command you are executing and see where to place the colon \":\" character. The character may not be detected if it's not followed by a space.",
+            "updated": 1610977564139
         },
         {
             "style": "Title",

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-001-docs-message-saving-succeed.json

@@ -3,14 +3,14 @@
     "pageNumber": 1,
     "type": "Docs Message - Saving Succeed",
     "definition": {
-        "text": "The docs.save command you executed was successful and all changes have been saved at the Superalgos Client.",
-        "updated": 1609783244197
+        "text": "The docs.save command was successful and all changes were saved at the Superalgos Client.",
+        "updated": 1610973296568
     },
     "paragraphs": [
         {
             "style": "Success",
-            "text": "All the latest changes to node, concept, topic and book pages have benn saved to disk.",
-            "updated": 1609832163904
+            "text": "All the latest changes to node, concept, topic, tutorial, review, and book pages have been saved to disk.",
+            "updated": 1610973308339
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-002-docs-message-reindexing-started.json

@@ -3,14 +3,22 @@
     "pageNumber": 2,
     "type": "Docs Message - Reindexing Started",
     "definition": {
-        "text": "The docs.reindex command you executed succesfully started the rebuing of the Docs Search Engine Index.",
-        "updated": 1609783396612
+        "text": "The docs.reindex command started the rebuilding of the Docs Search Engine Index.",
+        "updated": 1610972866423
     },
     "paragraphs": [
         {
             "style": "Success",
-            "text": "This is a very resourse intensive process. While this happens you will not be able to move arround since all the CPU resources are being used to recreate the index as fast as possible. The size of your workspace impacts the time to reindex the content since every node in it is scanned and all it's config and code are indexed. So hold on for a few minutes until the process finishes. Once it does, we will take you to a page that informs you of the result of the process.",
-            "updated": 1610353170958
+            "text": "Reindexing is a resource-intensive process. While the process is running, you will not be able to use the interface since all CPU resources are dedicated to recreating the index as fast as possible. ",
+            "updated": 1610973251479
+        },
+        {
+            "style": "Text",
+            "text": "The weight of your workspace impacts the time required to reindex the content since every node in the workspace must be scanned. All code and configurations are indexed. "
+        },
+        {
+            "style": "Text",
+            "text": "Hold on for a few seconds until the process finishes. You will receive a new message when it's over."
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-003-docs-message-reindexing-succeed.json

@@ -3,14 +3,14 @@
     "pageNumber": 3,
     "type": "Docs Message - Reindexing Succeed",
     "definition": {
-        "text": "The docs.reindex command you executed succesfully rebuilt the Docs Search Engine Index.",
-        "updated": 1609783396612
+        "text": "The docs.reindex command finished rebuilding the Docs Search Engine Index.",
+        "updated": 1610973361369
     },
     "paragraphs": [
         {
             "style": "Success",
-            "text": "The index was rebuilt and now includes all the latest changes you have made since you open the UI or since the last time you executed the docs.reindex command. That means that new content created now should affect the search results. Also, changes in the Workspace have been applied to the index too.",
-            "updated": 1609783508213
+            "text": "The index was rebuilt and now includes all the latest changes you made since you open the UI or since the last time you run the docs.reindex command. That means that new content created is now searchable. Changes in the Workspace have been entered in the index too.",
+            "updated": 1610973446156
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-004-docs-message-deleting-succeed.json

@@ -3,14 +3,14 @@
     "pageNumber": 4,
     "type": "Docs Message - Deleting Succeed",
     "definition": {
-        "text": "The docs.delete command you executed successfuly deleted the page you requested.",
-        "updated": 1610292270590
+        "text": "The docs.delete command deleted from memory the page you requested.",
+        "updated": 1610973738997
     },
     "paragraphs": [
         {
             "style": "Important",
-            "text": "The page was flagged to be deleted. It will be removed from the in-memory collection of pages once you run the Docs Save Command. Even after that it will still be indexed at the Docs Search Engine Index. To remove it from the index you need to execute Docs Reindex Command. The Docs Save Command will instruct the Client to delete it from it's disk.",
-            "updated": 1610292163004
+            "text": "The page was flagged to be deleted. It will be removed from the in-memory collection of pages once you run the Docs Save Command. The Docs Save Command instructs the Client to delete the file from disk. To remove the page from the index you must run the Docs Reindex Command.",
+            "updated": 1610973712136
         }
     ]
 }

Projects/Superalgos/Schemas/Docs-Topics/docs-commands-messages-005-docs-message-repagination-succeed.json

@@ -3,8 +3,8 @@
     "pageNumber": 5,
     "type": "Docs Message - Repagination Succeed",
     "definition": {
-        "text": "The docs.repaginate command you executed successfuly.",
-        "updated": 1610292270590
+        "text": "The docs.repaginate command finished repaginating.",
+        "updated": 1610973772448
     },
     "paragraphs": [
         {