From fd0b6f0e5c28b35d898378fd4ebbfc7d5b305c7d Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 19 Feb 2021 18:17:03 +0100 Subject: [PATCH] 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