From 4b2ee3d9a468781717ecd8b67ac03d8f3edf991d Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 20:57:51 +0100 Subject: [PATCH 1/3] Docs Commands --- .../Schemas/Docs-Books/the-docs-explained.json | 8 ++++---- .../docs-commands-002-docs-goto-command.json | 15 ++++++++------- .../docs-commands-003-docs-add-command.json | 8 ++++---- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json b/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json index 3b7cb2507..9f3e3c94f 100644 --- a/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json +++ b/Projects/Superalgos/Schemas/Docs-Books/the-docs-explained.json @@ -7,13 +7,13 @@ "paragraphs": [ { "style": "Chapter", - "text": "I->Superalgos->Topic->Docs Basics->Read Chapter I to learn the basics concepts. They are the foundation that will let you understand the commands and styles explained later in this book.", - "updated": 1609763076399 + "text": "I->Superalgos->Topic->Docs Basics->Read Chapter I to learn the basic concepts; the foundation that will help you understand the commands and styles explained later in the book.", + "updated": 1613763974146 }, { "style": "Chapter", - "text": "II->Superalgos->Topic->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each available command.", - "updated": 1609763122458 + "text": "II->Superalgos->Topic->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each command.", + "updated": 1613764005330 }, { "style": "Chapter", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json index 08a618950..d3d1295e7 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-002-docs-goto-command.json @@ -24,22 +24,23 @@ }, { "style": "List", - "text": "Project: It's the project where the Node, Concept, Topic, Tutorial or Review is defined.", - "updated": 1610975746510 + "text": "Project: It's the project where the page is defined.", + "updated": 1613764369592 }, { "style": "List", - "text": "Docs Page Category: Node, Concept, Topic, Tutorial or Review.", - "updated": 1610975692859 + "text": "Docs Page Category: One of the available categories.", + "updated": 1613764395658 }, { "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, for Tutorials, the tutorial step name; for Reviews, the review page name.", - "updated": 1610975736116 + "text": "Docs Page Name: The name of the page.", + "updated": 1613764542342 }, { "style": "List", - "text": "Docs Page Anchor : This parameter is optional. If present, it refers to an Docs Anchor paragraph defined within the page." + "text": "Docs Page Anchor: This parameter is optional. When present, it refers to a Docs Paragraph with the Docs Anchor Style within the page.", + "updated": 1613764614157 }, { "style": "Title", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json index 94c68e4e2..ededc8ad6 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json @@ -116,13 +116,13 @@ }, { "style": "List", - "text": "Project: It's the project where the Node, Concept, Topic or Review is defined.", - "updated": 1610975793026 + "text": "Project: ", + "updated": 1613764318942 }, { "style": "List", - "text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.", - "updated": 1610975177859 + "text": "Docs Page Category", + "updated": 1613764246264 }, { "style": "List", From e34d9f3fe73cbd853a00942fb4579ac90127bfbd Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 21:17:05 +0100 Subject: [PATCH 2/3] Add --- .../docs-commands-003-docs-add-command.json | 108 +++++++----------- ...docs-commands-004-docs-delete-command.json | 11 +- .../docs-commands-005-docs-save-command.json | 8 +- 3 files changed, 53 insertions(+), 74 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json index ededc8ad6..6a5d7aadc 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json @@ -9,102 +9,76 @@ "paragraphs": [ { "style": "Title", - "text": "Syntax", - "updated": 1609150474236 - }, - { - "style": "Subtitle", - "text": "Option 1: ", - "updated": 1609149432117 + "text": "Single-Page Syntax", + "updated": 1613765343294 }, { "style": "Json", "text": "docs.add Node to Project: Docs Page Name", "updated": 1610975287652 }, + { + "style": "Json", + "text": "docs.add Concept to Project: Docs Page Name", + "updated": 1613765480011 + }, + { + "style": "Json", + "text": "docs.add Book to Project: Docs Page Name", + "updated": 1613765601657 + }, { "style": "Subtitle", - "text": "Example: ", - "updated": 1609149442319 + "text": "Examples:" }, { "style": "Json", "text": "docs.add Node to Superalgos: Binance API", "updated": 1610975052587 }, - { - "style": "Subtitle", - "text": "Option 2: ", - "updated": 1609149450546 - }, - { - "style": "Json", - "text": "docs.add Concept to Project: Docs Page Name", - "updated": 1609149807897 - }, - { - "style": "Subtitle", - "text": "Example: ", - "updated": 1609149457691 - }, { "style": "Json", "text": "docs.add Concept to Superalgos: Two-way Reference", "updated": 1610975077695 }, { - "style": "Subtitle", - "text": "Option 3: ", - "updated": 1609149464103 + "style": "Json", + "text": "docs.add Book to Superalgos: User Manual", + "updated": 1613765497851 + }, + { + "style": "Title", + "text": "Page-Collection Syntax", + "updated": 1613765650403 }, { "style": "Json", "text": "docs.add Topic to Project: Docs Topic Name->Docs Page Name->Docs Page Number", "updated": 1609149846658 }, + { + "style": "Json", + "text": "docs.add Tutorial to Project: Docs Tutorial Name->Docs Page Name->Docs Page Number", + "updated": 1613765711526 + }, + { + "style": "Json", + "text": "docs.add Review to Project: Docs Review Name->Docs Page Name" + }, { "style": "Subtitle", - "text": "Example: ", - "updated": 1609149471266 + "text": "Example:" }, { "style": "Json", "text": "docs.add Topic to Superalgos: Docs Styles->Docs Text Style->1", "updated": 1609149878993 }, - { - "style": "Subtitle", - "text": "Option 4:", - "updated": 1610706520317 - }, - { - "style": "Json", - "text": "docs.add Topic to Project: Docs Tutorial Name->Docs Page Name->Docs Page Number", - "updated": 1610706514194 - }, - { - "style": "Subtitle", - "text": "Example:" - }, { "style": "Json", "text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro->1", "updated": 1610975123605 }, - { - "style": "Subtitle", - "text": "Option 5:", - "updated": 1610706652124 - }, - { - "style": "Json", - "text": "docs.add Review to Project: Docs Review Name->Docs Page Name", - "updated": 1610975148914 - }, - { - "style": "Subtitle", - "text": "Example:" - }, { "style": "Json", "text": "docs.add Review to Project: Superalgos Project Review->Superalgos Review - Great Project!", @@ -116,28 +90,28 @@ }, { "style": "List", - "text": "Project: ", - "updated": 1613764318942 + "text": "Project: It's the project where the page is defined.", + "updated": 1613764802872 }, { "style": "List", - "text": "Docs Page Category", - "updated": 1613764246264 + "text": "Docs Page Category: One of the available categories.", + "updated": 1613764813920 }, { "style": "List", - "text": "Docs Topic / Tutorial / Review Name: The name of the topic /tutorial /review to which the new page will belong.", - "updated": 1610975248463 + "text": "Docs topic / tutorial / review name: The name of the topic / tutorial / review tthe new page will belong to.", + "updated": 1613764860640 }, { "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, for Tutorials, the tutorial step name; for Reviews, the review page name.", - "updated": 1610975361761 + "text": "Docs Page Name: The name of the page.", + "updated": 1613764889322 }, { "style": "List", - "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 + "text": "Docs Page Numer: Optional. The number affects the position in the corresponding table of contents only. If a Docs Page Number is not provided, the systems assigns one.", + "updated": 1613764928993 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json index 09a0c3a9e..41801ebf6 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json @@ -111,17 +111,18 @@ }, { "style": "List", - "text": "Project: It's the project where the Node, Concept, Topic or Review is defined.", - "updated": 1610975967746 + "text": "Project: It's the project where the page is defined.", + "updated": 1613764968224 }, { "style": "List", - "text": "Docs Page Category: Node, Concept, Topic, Tutorial, or Review.", - "updated": 1610975936004 + "text": "Docs Page Category: One of the available categories.", + "updated": 1613764977861 }, { "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, for Tutorials, the tutorial step name; for Reviews, the review page name." + "text": "Docs Page Name: The name of the page.", + "updated": 1613764988027 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json index ecfe4e249..7271e30fa 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-005-docs-save-command.json @@ -7,10 +7,14 @@ "updated": 1610976014577 }, "paragraphs": [ + { + "style": "Important", + "text": "Pages you create or modify remain solely in memory in the context of the browser session until you run this command. Only once you run this command are changes saved to disk. If you refresh the page or close the browser before running the Docs Save Command, changes are lost. Changes are applied to the Docs Search Engine Index only after you run the Docs Reindex Command.", + "updated": 1613765203137 + }, { "style": "Title", - "text": "Syntax", - "updated": 1609157736088 + "text": "Syntax" }, { "style": "Javascript", From faf6952a666f83a41440616a0809f482763c0738 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 21:48:20 +0100 Subject: [PATCH 3/3] Done --- .../docs-commands-003-docs-add-command.json | 65 ++++++---------- ...docs-commands-004-docs-delete-command.json | 74 +++++-------------- ...ocs-commands-006-docs-reindex-command.json | 7 +- 3 files changed, 46 insertions(+), 100 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json index 6a5d7aadc..a68df7b87 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-003-docs-add-command.json @@ -10,79 +10,62 @@ { "style": "Title", "text": "Single-Page Syntax", - "updated": 1613765343294 + "updated": 1613765905233 }, { "style": "Json", - "text": "docs.add Node to Project: Docs Page Name", - "updated": 1610975287652 - }, - { - "style": "Json", - "text": "docs.add Concept to Project: Docs Page Name", - "updated": 1613765480011 - }, - { - "style": "Json", - "text": "docs.add Book to Project: Docs Page Name", - "updated": 1613765601657 + "text": "docs.add [Node|Concept|Book] from Project: Docs Page Name", + "updated": 1613766020535 }, { "style": "Subtitle", - "text": "Examples:" + "text": "Examples", + "updated": 1613766032848 }, { "style": "Json", - "text": "docs.add Node to Superalgos: Binance API", - "updated": 1610975052587 + "text": "docs.add Node from Superalgos: Task", + "updated": 1609152405379 }, { "style": "Json", - "text": "docs.add Concept to Superalgos: Two-way Reference", - "updated": 1610975077695 + "text": "docs.add Concept from Superalgos: References", + "updated": 1613766054009 }, { "style": "Json", - "text": "docs.add Book to Superalgos: User Manual", - "updated": 1613765497851 + "text": "docs.add Book from Superalgos: User Manual", + "updated": 1613766091949 }, { "style": "Title", "text": "Page-Collection Syntax", - "updated": 1613765650403 + "updated": 1613766298709 }, { "style": "Json", - "text": "docs.add Topic to Project: Docs Topic Name->Docs Page Name->Docs Page Number", - "updated": 1609149846658 - }, - { - "style": "Json", - "text": "docs.add Tutorial to Project: Docs Tutorial Name->Docs Page Name->Docs Page Number", - "updated": 1613765711526 - }, - { - "style": "Json", - "text": "docs.add Review to Project: Docs Review Name->Docs Page Name" + "text": "docs.add [Topic|Tutorial|Review] from Project: Docs [Topic|Tutorial|Review] Name->Docs Page Name->Docs Page Number", + "updated": 1613766367064 }, { "style": "Subtitle", - "text": "Example:" + "text": "Examples", + "updated": 1613766391018 }, { "style": "Json", - "text": "docs.add Topic to Superalgos: Docs Styles->Docs Text Style->1", - "updated": 1609149878993 + "text": "docs.add Topic from Superalgos: Docs Styles->Docs Text Style->1", + "updated": 1609152521245 }, { "style": "Json", - "text": "docs.add Tutorial to Superalgos: How to Build Indicators->Intro->1", - "updated": 1610975123605 + "text": "docs.add Tutorial from Superalgos: How to Build Indicatiors->Intro->1", + "updated": 1610707006603 }, { "style": "Json", - "text": "docs.add Review to Project: Superalgos Project Review->Superalgos Review - Great Project!", - "updated": 1610706675495 + "text": "docs.add Review from Project: Superalgos Project Review->Awasome!->2", + "updated": 1610707101903 }, { "style": "Title", @@ -100,8 +83,8 @@ }, { "style": "List", - "text": "Docs topic / tutorial / review name: The name of the topic / tutorial / review tthe new page will belong to.", - "updated": 1613764860640 + "text": "Docs topic / tutorial / review name: The name of the topic / tutorial / review the new page will belong to.", + "updated": 1613767524694 }, { "style": "List", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json index 41801ebf6..a45e691f1 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-004-docs-delete-command.json @@ -9,22 +9,18 @@ "paragraphs": [ { "style": "Title", - "text": "Syntax", - "updated": 1609152160707 - }, - { - "style": "Subtitle", - "text": "Option 1:", - "updated": 1609152344322 + "text": "Single-Page Syntax", + "updated": 1613765905233 }, { "style": "Json", - "text": "docs.delete Node from Project: Docs Page Name", - "updated": 1609152359725 + "text": "docs.delete [Node|Concept|Book] from Project: Docs Page Name", + "updated": 1613766020535 }, { "style": "Subtitle", - "text": "Example:" + "text": "Examples", + "updated": 1613766032848 }, { "style": "Json", @@ -32,74 +28,40 @@ "updated": 1609152405379 }, { - "style": "Subtitle", - "text": "Option 2:" + "style": "Json", + "text": "docs.delete Concept from Superalgos: References", + "updated": 1613766054009 }, { "style": "Json", - "text": "docs.delete Concept from Project: Docs Page Name", - "updated": 1609152445366 + "text": "docs.delete Book from Superalgos: User Manual", + "updated": 1613766091949 }, { - "style": "Subtitle", - "text": "Example:" + "style": "Title", + "text": "Page-Collection Syntax", + "updated": 1613766298709 }, { "style": "Json", - "text": " docs.delete Concept from Superalgos", - "updated": 1609152464312 + "text": "docs.delete [Topic|Tutorial|Review] from Project: Docs [Topic|Tutorial|Review] Name->Docs Page Name->Docs Page Number", + "updated": 1613766367064 }, { "style": "Subtitle", - "text": "Option 3:" - }, - { - "style": "Json", - "text": "docs.delete Topic from Project: Docs Topic Name->Docs Page Name->Docs Page Number", - "updated": 1609152484236 - }, - { - "style": "Subtitle", - "text": "Example:" + "text": "Examples", + "updated": 1613766391018 }, { "style": "Json", "text": "docs.delete Topic from Superalgos: Docs Styles->Docs Text Style->1", "updated": 1609152521245 }, - { - "style": "Subtitle", - "text": "Option 4:", - "updated": 1610706965604 - }, - { - "style": "Json", - "text": "docs.delete Tutorial from Project: Docs Tutorial Name->Docs Page Name->Docs Page Number", - "updated": 1610706951438 - }, - { - "style": "Subtitle", - "text": "Example:" - }, { "style": "Json", "text": "docs.delete Tutorial from Superalgos: How to Build Indicatiors->Intro->1", "updated": 1610707006603 }, - { - "style": "Subtitle", - "text": "Option 5:", - "updated": 1610707021714 - }, - { - "style": "Json", - "text": "docs.delete Review from Project: Docs Review Name->Docs Page Name->Docs Page Number", - "updated": 1610707068615 - }, - { - "style": "Subtitle", - "text": "Example:" - }, { "style": "Json", "text": "docs.delete Review from Project: Superalgos Project Review->Awasome!->2", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-006-docs-reindex-command.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-006-docs-reindex-command.json index 5d9f37531..81576e33e 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-006-docs-reindex-command.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-commands-006-docs-reindex-command.json @@ -3,8 +3,8 @@ "pageNumber": "6", "type": "Docs Reindex Command", "definition": { - "text": "Use this command to re-index all the pages of the docs, together with all the nodes at the current workspace, so that any changes you made to the content is available through search. ", - "updated": 1609152126427 + "text": "Use this command to re-index all the pages of the Docs, together with all the nodes in the current workspace. Changes you made to the content become available through search after running the command.", + "updated": 1613767645758 }, "paragraphs": [ { @@ -19,7 +19,8 @@ }, { "style": "Note", - "text": "The reindexing of all the pages and workspace node might take a minute or two. If you workspace is very big, expect it to take even more time than that." + "text": "The reindexing of all the pages and workspace node might take a minute or two. If you workspace is very big, expect it to take even more than that.", + "updated": 1613767567798 } ] } \ No newline at end of file