From 8781496ff5b6e9e971b42f90694042fa0e6826cc Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 17:06:23 +0100 Subject: [PATCH 1/5] Docs Basics revision --- .../Schemas/Docs-Topics/docs-basics-001-docs-intro.json | 4 ++-- .../Docs-Topics/docs-basics-002-docs-page-category.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json index 9db8dd900..bb0031e55 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json @@ -9,8 +9,8 @@ "paragraphs": [ { "style": "Text", - "text": "The Docs pages are organized in categories, explained in the page Docs Page Category.", - "updated": 1609151246461 + "text": "The Docs pages are organized in categories, as explained in the page Docs Page Category.", + "updated": 1613750690826 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json index 25196c154..8e808304f 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json @@ -3,8 +3,8 @@ "pageNumber": "2", "type": "Docs Page Category", "definition": { - "text": "The Docs feature five different categories of pages. Node, Concept, Topic, Tutorial, and Review. Each of them is a collection of pages users may read.", - "updated": 1610999695838 + "text": "The Docs feature five different categories of pages. Node, Concept, Topic, Tutorial, and Review. Each of them is a collection of pages.", + "updated": 1613750716651 }, "paragraphs": [ { From d977aaf66fe9008c142127ceaafb86ac5c971115 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 17:49:55 +0100 Subject: [PATCH 2/5] Repagination --- .../docs-basics-001-docs-intro.json | 25 +++++++++++++++---- ...ge.json => docs-basics-002-docs-page.json} | 2 +- ...> docs-basics-003-docs-page-category.json} | 14 +++++++---- ...on => docs-basics-004-docs-page-name.json} | 11 +++++++- ...n => docs-basics-005-docs-topic-name.json} | 2 +- ...> docs-basics-006-docs-tutorial-name.json} | 2 +- ... => docs-basics-007-docs-page-number.json} | 2 +- ...on => docs-basics-008-docs-node-page.json} | 2 +- ...=> docs-basics-009-docs-concept-page.json} | 2 +- ...n => docs-basics-010-docs-topic-page.json} | 2 +- ...on => docs-basics-011-docs-paragraph.json} | 4 +-- .../docs-basics-012-docs-page-block.json | 2 +- .../docs-basics-013-docs-nodes.json | 2 +- .../docs-basics-014-docs-concepts.json | 2 +- .../docs-basics-015-docs-topics.json | 2 +- .../docs-basics-016-docs-books.json | 2 +- ...docs-basics-017-docs-paragraph-styles.json | 2 +- .../docs-basics-018-docs-search-engine.json | 2 +- ...s-basics-019-docs-search-engine-index.json | 2 +- 19 files changed, 56 insertions(+), 28 deletions(-) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-010-docs-page.json => docs-basics-002-docs-page.json} (95%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-002-docs-page-category.json => docs-basics-003-docs-page-category.json} (80%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-003-docs-page-name.json => docs-basics-004-docs-page-name.json} (53%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-004-docs-topic-name.json => docs-basics-005-docs-topic-name.json} (94%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-005-docs-tutorial-name.json => docs-basics-006-docs-tutorial-name.json} (95%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-006-docs-page-number.json => docs-basics-007-docs-page-number.json} (95%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-007-docs-node-page.json => docs-basics-008-docs-node-page.json} (95%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-008-docs-concept-page.json => docs-basics-009-docs-concept-page.json} (94%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-009-docs-topic-page.json => docs-basics-010-docs-topic-page.json} (94%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-011-docs-paragraoh.json => docs-basics-011-docs-paragraph.json} (85%) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json index bb0031e55..6051c0223 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json @@ -1,16 +1,31 @@ { "topic": "Docs Basics", - "pageNumber": "1", + "pageNumber": 1, "type": "Docs Intro", "definition": { - "text": "The Docs is a Space within the Superalgos Project. It allows users to search for information relative to nodes, concepts, topics, tutorials and reviews related to different projects.", - "updated": 1610999626947 + "text": "The Docs is a Space within the Superalgos Project. It allows users to search for information relative to nodes, concepts, topics, tutorials, reviews, and books related to different projects.", + "updated": 1613751739473 }, "paragraphs": [ { "style": "Text", - "text": "The Docs pages are organized in categories, as explained in the page Docs Page Category.", - "updated": 1613750690826 + "text": "The Docs is a collection of pages organized in categories, each one saved as a JSON file in the following path:", + "updated": 1613752033968 + }, + { + "style": "Json", + "text": "Projects/[Project]/Schemas/", + "updated": 1613751994798 + }, + { + "style": "Text", + "text": "A directory structure follows, with each folder featuring a Docs Page Category:", + "updated": 1613751615450 + }, + { + "style": "Json", + "text": "> Docs-Books\n> Docs-Concepts\n> Docs-Nodes\n> Docs-Reviews\n> Docs-Topics\n> Docs-Tutorials", + "updated": 1613751705622 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json similarity index 95% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json index 9364f3602..ade27edfd 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "10", + "pageNumber": 2, "type": "Docs Page", "definition": { "text": "The Docs is a collection of pages classified in five different categories: Docs Nodes, Docs Concepts, Docs Topics, Docs Tutorials, and Docs Reviews.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json similarity index 80% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json index 8e808304f..6e10ecbad 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page-category.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "2", + "pageNumber": 3, "type": "Docs Page Category", "definition": { "text": "The Docs feature five different categories of pages. Node, Concept, Topic, Tutorial, and Review. Each of them is a collection of pages.", @@ -14,8 +14,12 @@ }, { "style": "Text", - "text": "For each Node defined within the Project, there is a Docs Node Page explaining what the Node is used for.", - "updated": 1610999767253 + "text": "Each Node defined in the Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens through the help button in the node's menu.", + "updated": 1613750893280 + }, + { + "style": "Text", + "text": "" }, { "style": "Title", @@ -24,8 +28,8 @@ }, { "style": "Text", - "text": "Concepts are notions that are not represented as nodes in the system. They are not ellaborate or deep enough to require a topic.", - "updated": 1610999879515 + "text": "Concepts are notions that are not represented as nodes. Concepts are not elaborate or deep enough to require a topic.", + "updated": 1613751085170 }, { "style": "Title", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json similarity index 53% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json index 44fbbb518..d857c8d86 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "3", + "pageNumber": 4, "type": "Docs Page Name", "definition": { "text": "The Docs Page Name is not only the visible name of a page, but also the unique identifier of a page within a Project.", @@ -11,6 +11,15 @@ "style": "Text", "text": "The page name is always featured as the main title of the page.", "updated": 1611000245347 + }, + { + "style": "Important", + "text": "At this point, the name of the page may not be changed from within the Docs interface. To change the name of the page you need to manually modify the corresponding file, editing the type field.", + "updated": 1613751344931 + }, + { + "style": "Text", + "text": "" } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-topic-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json similarity index 94% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-topic-name.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json index a83a293e4..e12f54731 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-topic-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "4", + "pageNumber": 5, "type": "Docs Topic Name", "definition": { "text": "Refers to the name of the topic, which in turn is a collection of related pages.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json similarity index 95% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json index bed0bc808..915e78476 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "5", + "pageNumber": 6, "type": "Docs Tutorial Name", "definition": { "text": "Refers to the name of the tutorial, which in turn is a collection of related pages.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json similarity index 95% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json index b8aae86ca..8a5943e93 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "6", + "pageNumber": 7, "type": "Docs Page Number", "definition": { "text": "Each topic or tutorial page has a sequential page number. The page number is used to build the corresponding table of content.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json similarity index 95% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json index 3c80a3e2d..b09bcd648 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "7", + "pageNumber": 8, "type": "Docs Node Page", "definition": { "text": "Each node in a Project should have a corresponding Node Page defining the node and explaining how it is used.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-concept-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json similarity index 94% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-concept-page.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json index 8bb7e69a0..9a1e61f7c 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-concept-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "8", + "pageNumber": 9, "type": "Docs Concept Page", "definition": { "text": "Write here a summary for this topic page." diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-topic-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json similarity index 94% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-topic-page.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json index 78d6b8d3f..d0bcb469c 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-topic-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "9", + "pageNumber": 10, "type": "Docs Topic Page", "definition": { "text": "Write here a summary for this topic page." diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraoh.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json similarity index 85% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraoh.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json index 563741591..3ac1e71a1 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraoh.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json @@ -1,7 +1,7 @@ { "topic": "Docs Basics", - "pageNumber": "11", - "type": "Docs Paragraoh", + "pageNumber": 11, + "type": "Docs Paragraph", "definition": { "text": "Write here a summary for this topic page." }, diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json index 498931576..be7c60e79 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "12", + "pageNumber": 12, "type": "Docs Page Block", "definition": { "text": "A Page Block is a set of paragraphs in a Docs Page. The block starts on the paragraph assigned the Docs Block Style.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json index fb6aaba2b..9da99a8a4 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "13", + "pageNumber": 13, "type": "Docs Nodes", "definition": { "text": "Docs Nodes is the set of pages featured under the Docs Page Category Node.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json index d55b7329d..f6c2528b9 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "14", + "pageNumber": 14, "type": "Docs Concepts", "definition": { "text": "Docs Concepts is the set of pages featured under the Docs Page Category Concept.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json index f558b67f5..58cf03f89 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "15", + "pageNumber": 15, "type": "Docs Topics", "definition": { "text": "Docs Topics is the set of pages featured under the Docs Page Category Topic.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json index bcc99506d..b108f3e1d 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "16", + "pageNumber": 16, "type": "Docs Books", "definition": { "text": "A book is a page that lists chapters. A chapters points to a Docs Topics, and is rendered as the table of contents of the topic in question.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json index a9ca220ed..21d9784a9 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "17", + "pageNumber": 17, "type": "Docs Paragraph Styles", "definition": { "text": "Each paragraph in a Docs Page is assigned a style. The default and most commonly used style is the Docs Text Style.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json index 2fa750d9a..04518a922 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "18", + "pageNumber": 18, "type": "Docs Search Engine", "definition": { "text": "The Docs feature a search engine that allows users to search through the collection of pages.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json index 0427c3599..f46f27db9 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": "19", + "pageNumber": 19, "type": "Docs Search Engine Index", "definition": { "text": "The Docs Search Engine builds an in-memory index that contains all the phrases of all Docs Pages, plus the name, type, config, and code of all nodes of the current Workspace.", From fd0b6f0e5c28b35d898378fd4ebbfc7d5b305c7d Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 18:17:03 +0100 Subject: [PATCH 3/5] This is my contribution to Superalgos --- .../docs-basics-001-docs-intro.json | 23 +++----------- .../docs-basics-002-docs-page.json | 20 +++++++++++-- .../docs-basics-003-docs-page-category.json | 30 ++++++++++++------- 3 files changed, 41 insertions(+), 32 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json index 6051c0223..f725d141e 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json @@ -3,29 +3,14 @@ "pageNumber": 1, "type": "Docs Intro", "definition": { - "text": "The Docs is a Space within the Superalgos Project. It allows users to search for information relative to nodes, concepts, topics, tutorials, reviews, and books related to different projects.", - "updated": 1613751739473 + "text": "The Docs is a Space within the Superalgos Project. It allows users to search for information relative to nodes, concepts, topics, tutorials, reviews, and books.", + "updated": 1613753494568 }, "paragraphs": [ { "style": "Text", - "text": "The Docs is a collection of pages organized in categories, each one saved as a JSON file in the following path:", - "updated": 1613752033968 - }, - { - "style": "Json", - "text": "Projects/[Project]/Schemas/", - "updated": 1613751994798 - }, - { - "style": "Text", - "text": "A directory structure follows, with each folder featuring a Docs Page Category:", - "updated": 1613751615450 - }, - { - "style": "Json", - "text": "> Docs-Books\n> Docs-Concepts\n> Docs-Nodes\n> Docs-Reviews\n> Docs-Topics\n> Docs-Tutorials", - "updated": 1613751705622 + "text": "Each project integrated in Superalgos may have it's own collection of pages conforming the project's documentation.", + "updated": 1613753557044 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json index ade27edfd..a566100e0 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json @@ -3,13 +3,27 @@ "pageNumber": 2, "type": "Docs Page", "definition": { - "text": "The Docs is a collection of pages classified in five different categories: Docs Nodes, Docs Concepts, Docs Topics, Docs Tutorials, and Docs Reviews.", - "updated": 1611000990872 + "text": "A Docs Page is ultimately a JSON file stored on disk.", + "updated": 1613753659983 }, "paragraphs": [ { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "The Docs is a collection of pages organized in categories, each one saved as a JSON file in the following path:", + "updated": 1613753810848 + }, + { + "style": "Json", + "text": " Projects/[Project]/Schemas/" + }, + { + "style": "Text", + "text": "A directory structure follows, with each folder featuring a Docs Page Category:" + }, + { + "style": "Json", + "text": "> Docs-Books\n> Docs-Concepts\n> Docs-Nodes\n> Docs-Reviews\n> Docs-Topics\n> Docs-Tutorials", + "updated": 1613753586990 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json index 6e10ecbad..4e9465ec5 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json @@ -3,8 +3,8 @@ "pageNumber": 3, "type": "Docs Page Category", "definition": { - "text": "The Docs feature five different categories of pages. Node, Concept, Topic, Tutorial, and Review. Each of them is a collection of pages.", - "updated": 1613750716651 + "text": "The Docs feature six categories of pages: nodes, concepts, topics, tutorials, reviews, and books. Each category is represented by a tab in the Docs search results.", + "updated": 1613754155692 }, "paragraphs": [ { @@ -14,8 +14,8 @@ }, { "style": "Text", - "text": "Each Node defined in the Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens through the help button in the node's menu.", - "updated": 1613750893280 + "text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens when clicking the help button in the menu of the node.", + "updated": 1613754213596 }, { "style": "Text", @@ -28,8 +28,8 @@ }, { "style": "Text", - "text": "Concepts are notions that are not represented as nodes. Concepts are not elaborate or deep enough to require a topic.", - "updated": 1613751085170 + "text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page.", + "updated": 1613754367905 }, { "style": "Title", @@ -37,8 +37,8 @@ }, { "style": "Text", - "text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts.", - "updated": 1610999935621 + "text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts, arranged in a sequence. However, is not a page in and of itself. Instead, it is a collection of pages.", + "updated": 1613754630115 }, { "style": "Title", @@ -46,8 +46,8 @@ }, { "style": "Text", - "text": "Tutorials are made of steps, and each step draws information from a tutorial step page in the Docs. Pages in a tutorial are arranged in a sequence.", - "updated": 1611000079464 + "text": "A Tutorial hierarchy may arrange different types of nodes including Tutorial Topic and Tutorial Step nodes. Each node in the hierarchy points to a Tutorial Step Page in the Docs from which it draws information. In the context of the Docs, pages in a tutorial are arranged in a sequence, like with topics.", + "updated": 1613754897247 }, { "style": "Title", @@ -58,6 +58,16 @@ "style": "Text", "text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects.", "updated": 1611000148351 + }, + { + "style": "Title", + "text": "Books Page Category", + "updated": 1613754499669 + }, + { + "style": "Text", + "text": "A books is a page in and of itself. The page features a list of topics each constituting a chapter in the book.", + "updated": 1613754996390 } ] } \ No newline at end of file From 5e446f48acd467a0fb462f3ca482a68aaed9aedd Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 18:54:48 +0100 Subject: [PATCH 4/5] Mid pages --- .../docs-basics-001-docs-intro.json | 4 +- .../docs-basics-002-docs-page.json | 4 +- .../docs-basics-003-docs-page-category.json | 43 ++++++++----------- .../docs-basics-004-docs-page-name.json | 21 ++++++--- .../docs-basics-005-docs-topic-name.json | 8 ++-- .../docs-basics-006-docs-tutorial-name.json | 8 ++-- .../docs-basics-007-docs-page-number.json | 9 +++- .../docs-basics-008-docs-node-page.json | 33 ++++++++++++-- .../docs-basics-009-docs-concept-page.json | 6 ++- .../docs-basics-011-docs-paragraph.json | 6 ++- .../docs-basics-012-docs-page-block.json | 4 +- 11 files changed, 91 insertions(+), 55 deletions(-) diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json index f725d141e..4a4cce464 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-001-docs-intro.json @@ -9,8 +9,8 @@ "paragraphs": [ { "style": "Text", - "text": "Each project integrated in Superalgos may have it's own collection of pages conforming the project's documentation.", - "updated": 1613753557044 + "text": "Each project integrated in Superalgos may have it's own collection of pages making up the project's documentation.", + "updated": 1613755052653 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json index a566100e0..ec4841068 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json @@ -9,8 +9,8 @@ "paragraphs": [ { "style": "Text", - "text": "The Docs is a collection of pages organized in categories, each one saved as a JSON file in the following path:", - "updated": 1613753810848 + "text": "The Docs is a collection of pages, each one saved as a JSON file in the following path:", + "updated": 1613755076008 }, { "style": "Json", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json index 4e9465ec5..d94594884 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json @@ -7,29 +7,26 @@ "updated": 1613754155692 }, "paragraphs": [ - { - "style": "Title", - "text": "Node Page Category", - "updated": 1609150842562 - }, - { - "style": "Text", - "text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens when clicking the help button in the menu of the node.", - "updated": 1613754213596 - }, { "style": "Text", "text": "" }, { "style": "Title", - "text": "Concept Page Category", - "updated": 1610999775828 + "text": "Node Page Category", + "updated": 1613756771488 }, { "style": "Text", - "text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page.", - "updated": 1613754367905 + "text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used. This is the page that opens when clicking the help button in the menu of the node." + }, + { + "style": "Title", + "text": "Concept Page Category" + }, + { + "style": "Text", + "text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page." }, { "style": "Title", @@ -37,8 +34,7 @@ }, { "style": "Text", - "text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts, arranged in a sequence. However, is not a page in and of itself. Instead, it is a collection of pages.", - "updated": 1613754630115 + "text": "Topics are multi-faceted, deep concepts that require more than one page to be correctly addressed. Topics are sets of closely related concepts, arranged in a sequence. However, is not a page in and of itself. Instead, it is a collection of pages." }, { "style": "Title", @@ -46,28 +42,23 @@ }, { "style": "Text", - "text": "A Tutorial hierarchy may arrange different types of nodes including Tutorial Topic and Tutorial Step nodes. Each node in the hierarchy points to a Tutorial Step Page in the Docs from which it draws information. In the context of the Docs, pages in a tutorial are arranged in a sequence, like with topics.", - "updated": 1613754897247 + "text": "A Tutorial hierarchy may arrange different types of nodes including Tutorial Topic and Tutorial Step nodes. Each node in the hierarchy points to a Tutorial Step Page in the Docs from which it draws information. In the context of the Docs, pages in a tutorial are arranged in a sequence, like with topics." }, { "style": "Title", - "text": "Reviews Page Category", - "updated": 1611000089258 + "text": "Reviews Page Category" }, { "style": "Text", - "text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects.", - "updated": 1611000148351 + "text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects." }, { "style": "Title", - "text": "Books Page Category", - "updated": 1613754499669 + "text": "Books Page Category" }, { "style": "Text", - "text": "A books is a page in and of itself. The page features a list of topics each constituting a chapter in the book.", - "updated": 1613754996390 + "text": "A books is a page in and of itself. The page features a list of topics each constituting a chapter in the book." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json index d857c8d86..c761ac3a9 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json @@ -3,19 +3,28 @@ "pageNumber": 4, "type": "Docs Page Name", "definition": { - "text": "The Docs Page Name is not only the visible name of a page, but also the unique identifier of a page within a Project.", - "updated": 1611000211462 + "text": "The Docs Page Name is not only the visible name of a page displayed as the main title at the top but also the unique identifier of a page within a Project.", + "updated": 1613755348083 }, "paragraphs": [ { "style": "Text", - "text": "The page name is always featured as the main title of the page.", - "updated": 1611000245347 + "text": "The page name is always featured as the main title of the page and no two pages may have the same name.", + "updated": 1613755273710 + }, + { + "style": "Success", + "text": "It is important to remember the above at the time of naming a page. You should always use an unambiguous descriptive name as the name of a page.", + "updated": 1613755338171 + }, + { + "style": "Text", + "text": "" }, { "style": "Important", - "text": "At this point, the name of the page may not be changed from within the Docs interface. To change the name of the page you need to manually modify the corresponding file, editing the type field.", - "updated": 1613751344931 + "text": "At this point, the name of the page may not be changed from within the Docs interface. To change the name of the page you need to manually modify the corresponding file, editing the type field and properly mapping the name of the page in the name of the file.", + "updated": 1613755498049 }, { "style": "Text", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json index e12f54731..ebea49107 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json @@ -3,14 +3,14 @@ "pageNumber": 5, "type": "Docs Topic Name", "definition": { - "text": "Refers to the name of the topic, which in turn is a collection of related pages.", - "updated": 1611000285171 + "text": "Refers to the name of the topic. Pages with the same Docs Topic Name belong to the same topic.", + "updated": 1613755594915 }, "paragraphs": [ { "style": "Text", - "text": "Topic names are used to group a set of related pages under a certain topic. ", - "updated": 1609182145551 + "text": "There is no page describing a topic. Instead, the Docs Topic Name is used to group a set of related pages under a certain topic.", + "updated": 1613755651132 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json index 915e78476..e843e1f45 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json @@ -3,14 +3,14 @@ "pageNumber": 6, "type": "Docs Tutorial Name", "definition": { - "text": "Refers to the name of the tutorial, which in turn is a collection of related pages.", - "updated": 1611000326995 + "text": "Refers to the name of the tutorial. Pages with the same Docs Tutorial Name belong to the same tutorial.", + "updated": 1613755729645 }, "paragraphs": [ { "style": "Text", - "text": "Tutorial names are used to group a set of related pages under a certain tutorial. ", - "updated": 1609182145551 + "text": "There is no page describing a tutorial. It is the Turotial hierarchy that determines how tutorials are arranged. However, in the context of the Docs, the Docs Tutorial Name is used to group a set of related pages under a certain tutorial.", + "updated": 1613755796749 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json index 8a5943e93..5ddfc5bb1 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json @@ -8,8 +8,13 @@ }, "paragraphs": [ { - "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "style": "Important", + "text": "At this point, the number of the page may not be changed from within the Docs interface. To change the number of the page you need to manually modify the corresponding file, editing the pageNumeber field and properly mapping the page number of the page in the name of the file.", + "updated": 1613755941767 + }, + { + "style": "Success", + "text": "The Docs Repaginate Command helps with arranging page numbers of large collection of pages." } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json index b09bcd648..a51d78f27 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json @@ -3,13 +3,40 @@ "pageNumber": 8, "type": "Docs Node Page", "definition": { - "text": "Each node in a Project should have a corresponding Node Page defining the node and explaining how it is used.", - "updated": 1611000867717 + "text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used.", + "updated": 1613756218722 }, "paragraphs": [ { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "This is the page that opens when clicking the help button in the menu of the node.", + "updated": 1613756213394 + }, + { + "style": "Text", + "text": "A Docs Node Page features:" + }, + { + "style": "List", + "text": "Definition: a short description of what the node is, and what it represents in the hierarchy. The definition is displayed to the left of the node's icon.", + "updated": 1613756314649 + }, + { + "style": "List", + "text": "Content: all the information relative to the node in terms of how the node is used, how it affects operations, or how it relates to other nodes.", + "updated": 1613756365684 + }, + { + "style": "List", + "text": "Configuration: a section describing the elements of the node's configuration file." + }, + { + "style": "List", + "text": "Auto-generated content: information extracted from the system, workspace, etc., to provide the technical context in which the node exists." + }, + { + "style": "Text", + "text": "" } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json index 9a1e61f7c..58be9a029 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json @@ -3,12 +3,14 @@ "pageNumber": 9, "type": "Docs Concept Page", "definition": { - "text": "Write here a summary for this topic page." + "text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page.", + "updated": 1613756750385 }, "paragraphs": [ { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "The page of a concept is self-contained.", + "updated": 1613756891822 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json index 3ac1e71a1..a725ba5e7 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json @@ -3,12 +3,14 @@ "pageNumber": 11, "type": "Docs Paragraph", "definition": { - "text": "Write here a summary for this topic page." + "text": "A paragraph is the smallest unit of information managed by the Docs. In a way, a Docs Page is made of paragraphs.", + "updated": 1613757043006 }, "paragraphs": [ { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "A paragraph may have a style, as explained in the Docs Paragraph Styles page.", + "updated": 1613757122601 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json index be7c60e79..761818b5b 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json @@ -9,8 +9,8 @@ "paragraphs": [ { "style": "Text", - "text": "A block must have an opening paragraph with the Docs Block Style. The block may include any number of paragraphs. In practice, a block extends until the next block starts, or until the page ends.", - "updated": 1611001401401 + "text": "A block must have an opening paragraph with the Docs Block Style. The block may include any number of paragraphs. In practice, a block extends to the point where the next block starts, or until the page ends.", + "updated": 1613757178023 } ] } \ No newline at end of file From 32e90257835284e2854c017361bbae245c90ee79 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 19:45:55 +0100 Subject: [PATCH 5/5] Done --- .../Docs-Topics/docs-basics-002-docs-page.json | 4 ++-- .../docs-basics-003-docs-page-category.json | 4 ++-- ...son => docs-basics-004-docs-page-number.json} | 2 +- ....json => docs-basics-005-docs-page-name.json} | 2 +- ...json => docs-basics-006-docs-topic-name.json} | 2 +- ...n => docs-basics-007-docs-tutorial-name.json} | 2 +- ....json => docs-basics-008-docs-paragraph.json} | 2 +- ...> docs-basics-009-docs-paragraph-styles.json} | 5 +++-- ....json => docs-basics-010-docs-node-page.json} | 2 +- .../docs-basics-010-docs-topic-page.json | 14 -------------- ...on => docs-basics-011-docs-concept-page.json} | 2 +- .../docs-basics-012-docs-page-block.json | 16 ---------------- .../docs-basics-012-docs-review-page.json | 16 ++++++++++++++++ .../docs-basics-013-docs-book-page.json | 16 ++++++++++++++++ .../Docs-Topics/docs-basics-013-docs-nodes.json | 15 --------------- .../docs-basics-014-docs-concepts.json | 15 --------------- ...n => docs-basics-014-docs-search-engine.json} | 6 +++--- ...ocs-basics-015-docs-search-engine-index.json} | 2 +- .../Docs-Topics/docs-basics-015-docs-topics.json | 15 --------------- .../Docs-Topics/docs-basics-016-docs-books.json | 15 --------------- 20 files changed, 50 insertions(+), 107 deletions(-) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-007-docs-page-number.json => docs-basics-004-docs-page-number.json} (97%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-004-docs-page-name.json => docs-basics-005-docs-page-name.json} (98%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-005-docs-topic-name.json => docs-basics-006-docs-topic-name.json} (95%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-006-docs-tutorial-name.json => docs-basics-007-docs-tutorial-name.json} (96%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-011-docs-paragraph.json => docs-basics-008-docs-paragraph.json} (95%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-017-docs-paragraph-styles.json => docs-basics-009-docs-paragraph-styles.json} (68%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-008-docs-node-page.json => docs-basics-010-docs-node-page.json} (98%) delete mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-009-docs-concept-page.json => docs-basics-011-docs-concept-page.json} (96%) delete mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-review-page.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-book-page.json delete mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json delete mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-018-docs-search-engine.json => docs-basics-014-docs-search-engine.json} (71%) rename Projects/Superalgos/Schemas/Docs-Topics/{docs-basics-019-docs-search-engine-index.json => docs-basics-015-docs-search-engine-index.json} (96%) delete mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json delete mode 100644 Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json index ec4841068..b8d954960 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-002-docs-page.json @@ -22,8 +22,8 @@ }, { "style": "Json", - "text": "> Docs-Books\n> Docs-Concepts\n> Docs-Nodes\n> Docs-Reviews\n> Docs-Topics\n> Docs-Tutorials", - "updated": 1613753586990 + "text": " > Docs-Books\n> Docs-Concepts\n> Docs-Nodes\n> Docs-Reviews\n> Docs-Topics\n> Docs-Tutorials", + "updated": 1613757794574 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json index d94594884..b6953eb0f 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-category.json @@ -3,8 +3,8 @@ "pageNumber": 3, "type": "Docs Page Category", "definition": { - "text": "The Docs feature six categories of pages: nodes, concepts, topics, tutorials, reviews, and books. Each category is represented by a tab in the Docs search results.", - "updated": 1613754155692 + "text": "The Docs feature six categories of pages: nodes, concepts, topics, tutorials, reviews, and books. Each category is represented by a tab in the Docs Search Results.", + "updated": 1613759267463 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-number.json similarity index 97% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-number.json index 5ddfc5bb1..48adeab04 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-page-number.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-number.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 7, + "pageNumber": 4, "type": "Docs Page Number", "definition": { "text": "Each topic or tutorial page has a sequential page number. The page number is used to build the corresponding table of content.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-page-name.json similarity index 98% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-page-name.json index c761ac3a9..9584f3819 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-page-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-page-name.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 4, + "pageNumber": 5, "type": "Docs Page Name", "definition": { "text": "The Docs Page Name is not only the visible name of a page displayed as the main title at the top but also the unique identifier of a page within a Project.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-topic-name.json similarity index 95% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-topic-name.json index ebea49107..37d7660a7 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-topic-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-topic-name.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 5, + "pageNumber": 6, "type": "Docs Topic Name", "definition": { "text": "Refers to the name of the topic. Pages with the same Docs Topic Name belong to the same topic.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-tutorial-name.json similarity index 96% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-tutorial-name.json index e843e1f45..5d588c96a 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-tutorial-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-tutorial-name.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 6, + "pageNumber": 7, "type": "Docs Tutorial Name", "definition": { "text": "Refers to the name of the tutorial. Pages with the same Docs Tutorial Name belong to the same tutorial.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-paragraph.json similarity index 95% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-paragraph.json index a725ba5e7..bbb483973 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-paragraph.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-paragraph.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 11, + "pageNumber": 8, "type": "Docs Paragraph", "definition": { "text": "A paragraph is the smallest unit of information managed by the Docs. In a way, a Docs Page is made of paragraphs.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-paragraph-styles.json similarity index 68% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-paragraph-styles.json index 21d9784a9..58a67a3b6 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-017-docs-paragraph-styles.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-paragraph-styles.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 17, + "pageNumber": 9, "type": "Docs Paragraph Styles", "definition": { "text": "Each paragraph in a Docs Page is assigned a style. The default and most commonly used style is the Docs Text Style.", @@ -9,7 +9,8 @@ "paragraphs": [ { "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "text": "Styles are covered in the Docs Paragraph Styles topic.", + "updated": 1613760190825 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-node-page.json similarity index 98% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-node-page.json index a51d78f27..694974a18 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-008-docs-node-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-node-page.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 8, + "pageNumber": 10, "type": "Docs Node Page", "definition": { "text": "Each Node defined in the context of a Project features a Docs Node Page explaining what the Node is and how it is used.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json deleted file mode 100644 index d0bcb469c..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-topic-page.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "topic": "Docs Basics", - "pageNumber": 10, - "type": "Docs Topic Page", - "definition": { - "text": "Write here a summary for this topic page." - }, - "paragraphs": [ - { - "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-concept-page.json similarity index 96% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-concept-page.json index 58be9a029..80a17840c 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-009-docs-concept-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-011-docs-concept-page.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 9, + "pageNumber": 11, "type": "Docs Concept Page", "definition": { "text": "Concepts are notions or ideas that are not represented as nodes in a hierarchy. Pages in the concept category cover notions or ideas that may be explained in a single page. That is, concepts are notions that may be covered exhaustively on a single page.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json deleted file mode 100644 index 761818b5b..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-page-block.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "topic": "Docs Basics", - "pageNumber": 12, - "type": "Docs Page Block", - "definition": { - "text": "A Page Block is a set of paragraphs in a Docs Page. The block starts on the paragraph assigned the Docs Block Style.", - "updated": 1611001340654 - }, - "paragraphs": [ - { - "style": "Text", - "text": "A block must have an opening paragraph with the Docs Block Style. The block may include any number of paragraphs. In practice, a block extends to the point where the next block starts, or until the page ends.", - "updated": 1613757178023 - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-review-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-review-page.json new file mode 100644 index 000000000..99fefbb93 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-012-docs-review-page.json @@ -0,0 +1,16 @@ +{ + "topic": "Docs Basics", + "pageNumber": 12, + "type": "Docs Review Page", + "definition": { + "text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects.", + "updated": 1613756750385 + }, + "paragraphs": [ + { + "style": "Text", + "text": "The page of a review is self-contained.", + "updated": 1613756891822 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-book-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-book-page.json new file mode 100644 index 000000000..633741b3c --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-book-page.json @@ -0,0 +1,16 @@ +{ + "topic": "Docs Basics", + "pageNumber": 13, + "type": "Docs Book Page", + "definition": { + "text": "A book is a collection of topics, each representing a chapter in the book.", + "updated": 1613756750385 + }, + "paragraphs": [ + { + "style": "Text", + "text": "A books is a page in and of itself. The page features a list of topics each constituting a chapter in the book.", + "updated": 1613756891822 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json deleted file mode 100644 index 9da99a8a4..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-013-docs-nodes.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "topic": "Docs Basics", - "pageNumber": 13, - "type": "Docs Nodes", - "definition": { - "text": "Docs Nodes is the set of pages featured under the Docs Page Category Node.", - "updated": 1611001517868 - }, - "paragraphs": [ - { - "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json deleted file mode 100644 index f6c2528b9..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-concepts.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "topic": "Docs Basics", - "pageNumber": 14, - "type": "Docs Concepts", - "definition": { - "text": "Docs Concepts is the set of pages featured under the Docs Page Category Concept.", - "updated": 1611001547193 - }, - "paragraphs": [ - { - "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-search-engine.json similarity index 71% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-search-engine.json index 04518a922..117408917 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-018-docs-search-engine.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-014-docs-search-engine.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 18, + "pageNumber": 14, "type": "Docs Search Engine", "definition": { "text": "The Docs feature a search engine that allows users to search through the collection of pages.", @@ -9,8 +9,8 @@ "paragraphs": [ { "style": "Text", - "text": "The search engine builds a Docs Search Engine Index that is later used to find the phrases typed by users at the search box.", - "updated": 1609784587544 + "text": "The search engine builds a Docs Search Engine Index that is later used to find matches with the phrases users type at the search box.", + "updated": 1613760285709 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-search-engine-index.json similarity index 96% rename from Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json rename to Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-search-engine-index.json index f46f27db9..4c160a00e 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-019-docs-search-engine-index.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-search-engine-index.json @@ -1,6 +1,6 @@ { "topic": "Docs Basics", - "pageNumber": 19, + "pageNumber": 15, "type": "Docs Search Engine Index", "definition": { "text": "The Docs Search Engine builds an in-memory index that contains all the phrases of all Docs Pages, plus the name, type, config, and code of all nodes of the current Workspace.", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json deleted file mode 100644 index 58cf03f89..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-015-docs-topics.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "topic": "Docs Basics", - "pageNumber": 15, - "type": "Docs Topics", - "definition": { - "text": "Docs Topics is the set of pages featured under the Docs Page Category Topic.", - "updated": 1611001570988 - }, - "paragraphs": [ - { - "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." - } - ] -} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json deleted file mode 100644 index b108f3e1d..000000000 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-016-docs-books.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "topic": "Docs Basics", - "pageNumber": 16, - "type": "Docs Books", - "definition": { - "text": "A book is a page that lists chapters. A chapters points to a Docs Topics, and is rendered as the table of contents of the topic in question.", - "updated": 1611001687100 - }, - "paragraphs": [ - { - "style": "Text", - "text": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." - } - ] -} \ No newline at end of file