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 eb024197e..9db8dd900 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,8 +3,8 @@ "pageNumber": "1", "type": "Docs Intro", "definition": { - "text": "The Docs is a Space within Superalgos Project that allow users to search for information that explain the nodes, concepts and topics related to the different projects.", - "updated": 1609151076248 + "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 }, "paragraphs": [ { 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 568293e93..25196c154 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 have 3 different categories of pages. Node, Concept and Topic. Each of them is a collection of pages users can read.", - "updated": 1609161546617 + "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 }, "paragraphs": [ { @@ -14,16 +14,18 @@ }, { "style": "Text", - "text": "For each Node defined within the project, there is a Docs Node Page at the Docs, explaining what is that Node used for.", - "updated": 1609150987235 + "text": "For each Node defined within the Project, there is a Docs Node Page explaining what the Node is used for.", + "updated": 1610999767253 }, { "style": "Title", - "text": "Cocept Page Category" + "text": "Concept Page Category", + "updated": 1610999775828 }, { "style": "Text", - "text": "Concepts are things users must know that are not needed as a Node in the system and are not ellaborate enough to become a topic." + "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 }, { "style": "Title", @@ -31,7 +33,27 @@ }, { "style": "Text", - "text": "Topics are multi-faceted concepts that needs more than one page to be correctly explained. It is a set of closely related concepts." + "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 + }, + { + "style": "Title", + "text": "Tutorial Page Category" + }, + { + "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 + }, + { + "style": "Title", + "text": "Reviews Page Category", + "updated": 1611000089258 + }, + { + "style": "Text", + "text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects.", + "updated": 1611000148351 } ] } \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json index 0eb26795e..44fbbb518 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-003-docs-page-name.json @@ -3,14 +3,14 @@ "pageNumber": "3", "type": "Docs Page Name", "definition": { - "text": "The Docs Page Name is not only the visible name of a page, but also they key to identify a page in a unique way within a Project.", - "updated": 1609151319050 + "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 }, "paragraphs": [ { "style": "Text", - "text": "The page name can always be found at the top of each page.", - "updated": 1609151354901 + "text": "The page name is always featured as the main title of the page.", + "updated": 1611000245347 } ] } \ 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-004-docs-topic-name.json index e6327cb47..a83a293e4 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-topic-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-004-docs-topic-name.json @@ -3,8 +3,8 @@ "pageNumber": "4", "type": "Docs Topic Name", "definition": { - "text": "Refers to the name of the topic, which in turn is a collection of related pages at the Docs.", - "updated": 1609182060836 + "text": "Refers to the name of the topic, which in turn is a collection of related pages.", + "updated": 1611000285171 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json index 1f7f94483..bed0bc808 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-005-docs-tutorial-name.json @@ -3,8 +3,8 @@ "pageNumber": "5", "type": "Docs Tutorial Name", "definition": { - "text": "Refers to the name of the tutorial, which in turn is a collection of related pages at the Docs.", - "updated": 1609182060836 + "text": "Refers to the name of the tutorial, which in turn is a collection of related pages.", + "updated": 1611000326995 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json index db4a7dde4..b8aae86ca 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-006-docs-page-number.json @@ -3,8 +3,8 @@ "pageNumber": "6", "type": "Docs Page Number", "definition": { - "text": "Each topic page must have an assigned page number. The page number is used to build the topic index displayed at the top of each Docs Topic Page.", - "updated": 1609182198659 + "text": "Each topic or tutorial page has a sequential page number. The page number is used to build the corresponding table of content.", + "updated": 1611000559709 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json index e1f0136c4..3c80a3e2d 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-007-docs-node-page.json @@ -3,8 +3,8 @@ "pageNumber": "7", "type": "Docs Node Page", "definition": { - "text": "Each node of each Project have a corresponding Node Page at the Docs, explaining everything to be known about that node.", - "updated": 1609182353739 + "text": "Each node in a Project should have a corresponding Node Page defining the node and explaining how it is used.", + "updated": 1611000867717 }, "paragraphs": [ { diff --git a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json index c8d9e0009..9364f3602 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/docs-basics-010-docs-page.json @@ -3,8 +3,8 @@ "pageNumber": "10", "type": "Docs Page", "definition": { - "text": "The Docs is a collection of pages classified in 3 different categories: Docs Nodes, Docs Concepts and Docs Topics. A page contains information valuable for the users of the system.", - "updated": 1609260440891 + "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 }, "paragraphs": [ { 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 43957c615..498931576 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 @@ -3,13 +3,14 @@ "pageNumber": "12", "type": "Docs Page Block", "definition": { - "text": "A Page Block is a set of paragraphs within a specific Docs Page. A single Docs Page may have 0 to any number of paragraphs.", - "updated": 1609260648075 + "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": "Left click and Edit to enter edit mode and change this text. ENTER to write new paragraphs. ESC to exit edit mode." + "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 } ] } \ 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 index 2d94c506b..fb6aaba2b 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 @@ -3,8 +3,8 @@ "pageNumber": "13", "type": "Docs Nodes", "definition": { - "text": "Docs Nodes is the set of all pages in the Docs under the Docs Page Category of Node.", - "updated": 1609260759079 + "text": "Docs Nodes is the set of pages featured under the Docs Page Category Node.", + "updated": 1611001517868 }, "paragraphs": [ { 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 c339dfb27..d55b7329d 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 @@ -3,8 +3,8 @@ "pageNumber": "14", "type": "Docs Concepts", "definition": { - "text": "Docs Concepts is the set of all pages in the Docs under the Docs Page Category of Concept.", - "updated": 1609260746120 + "text": "Docs Concepts is the set of pages featured under the Docs Page Category Concept.", + "updated": 1611001547193 }, "paragraphs": [ { 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 4bfa4eed2..f558b67f5 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 @@ -3,8 +3,8 @@ "pageNumber": "15", "type": "Docs Topics", "definition": { - "text": "Docs Topics is the set of all pages in the Docs under the Docs Page Category of Topic.", - "updated": 1609260810214 + "text": "Docs Topics is the set of pages featured under the Docs Page Category Topic.", + "updated": 1611001570988 }, "paragraphs": [ { 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 cf2ca5497..bcc99506d 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 @@ -3,8 +3,8 @@ "pageNumber": "16", "type": "Docs Books", "definition": { - "text": "A book is page in the Docs that contains chapters. Chapters points to a Docs Topics and are rendered as the index table of the topic they point to.", - "updated": 1609771773385 + "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": [ { 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 4a75dd0ea..a9ca220ed 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 @@ -3,8 +3,8 @@ "pageNumber": "17", "type": "Docs Paragraph Styles", "definition": { - "text": "Each paragraph at a Docs Page, need to be assigend a style. The most commonly used style is the Docs Text Style.", - "updated": 1609260947769 + "text": "Each paragraph in a Docs Page is assigned a style. The default and most commonly used style is the Docs Text Style.", + "updated": 1611001762378 }, "paragraphs": [ { 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 150b34d45..2fa750d9a 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 @@ -3,8 +3,8 @@ "pageNumber": "18", "type": "Docs Search Engine", "definition": { - "text": "The Docs contains a search engine that allows users to search through the collection of pages.\n", - "updated": 1609784533352 + "text": "The Docs feature a search engine that allows users to search through the collection of pages.", + "updated": 1611001784831 }, "paragraphs": [ { 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 63d9364d5..0427c3599 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 @@ -3,14 +3,14 @@ "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.", - "updated": 1609784383995 + "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.", + "updated": 1611001817080 }, "paragraphs": [ { "style": "Text", - "text": "This index is built when the UI is launched, and rebuilt when users executes the docs.reindex command or they load a new workspace.", - "updated": 1609784471513 + "text": "This index is built when the UI is launched, and rebuilt when the user runs the docs.reindex command or loads a new Workspace.", + "updated": 1611001858537 } ] } \ No newline at end of file diff --git a/README.md b/README.md index 4b40f8fb6..ff2e1f1e5 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Before you begin, it is recommended that you set up Chrome as your default brows **Important:** Use Chrome so that you have a similar environment as the dev team in case you need help. We are not testing on any other browsers, and it is a well-known fact that browsers behave differently. -# Superalgos App Installation +# Superalgos Client Installation **1.** If you are not there already, go to [https://github.com/Superalgos/Superalgos](https://github.com/Superalgos/Superalgos)