Merge pull request #571 from julian-molina/develop

Contribution: Docs Basics revision
This commit is contained in:
Julian Molina authored and GitHub committed 2021-02-19 19:55:05 +01:00
commit 03940207d7
30 files changed
+297 -281

No files matched your search

@@ -1,16 +1,16 @@
{
"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.",
"updated": 1613753494568
},
"paragraphs": [
{
"style": "Text",
"text": "The Docs pages are organized in categories, explained in the page Docs Page Category.",
"updated": 1609151246461
"text": "Each project integrated in Superalgos may have it's own collection of pages making up the project's documentation.",
"updated": 1613755052653
}
]
}
@@ -1,59 +0,0 @@
{
"topic": "Docs Basics",
"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
},
"paragraphs": [
{
"style": "Title",
"text": "Node Page Category",
"updated": 1609150842562
},
{
"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
},
{
"style": "Title",
"text": "Concept Page Category",
"updated": 1610999775828
},
{
"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
},
{
"style": "Title",
"text": "Topic Page Category"
},
{
"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
},
{
"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
}
]
}
@@ -0,0 +1,29 @@
{
"topic": "Docs Basics",
"pageNumber": 2,
"type": "Docs Page",
"definition": {
"text": "A Docs Page is ultimately a JSON file stored on disk.",
"updated": 1613753659983
},
"paragraphs": [
{
"style": "Text",
"text": "The Docs is a collection of pages, each one saved as a JSON file in the following path:",
"updated": 1613755076008
},
{
"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": 1613757794574
}
]
}
@@ -0,0 +1,64 @@
{
"topic": "Docs Basics",
"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": 1613759267463
},
"paragraphs": [
{
"style": "Text",
"text": ""
},
{
"style": "Title",
"text": "Node Page Category",
"updated": 1613756771488
},
{
"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."
},
{
"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",
"text": "Topic Page Category"
},
{
"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."
},
{
"style": "Title",
"text": "Tutorial Page Category"
},
{
"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."
},
{
"style": "Title",
"text": "Reviews Page Category"
},
{
"style": "Text",
"text": "Reviews are user-generated content describing their experience with certain components of Superalgos or other projects."
},
{
"style": "Title",
"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."
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "3",
"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
},
"paragraphs": [
{
"style": "Text",
"text": "The page name is always featured as the main title of the page.",
"updated": 1611000245347
}
]
}
@@ -0,0 +1,20 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1611000559709
},
"paragraphs": [
{
"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."
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "4",
"type": "Docs Topic Name",
"definition": {
"text": "Refers to the name of the topic, which in turn is a collection of related pages.",
"updated": 1611000285171
},
"paragraphs": [
{
"style": "Text",
"text": "Topic names are used to group a set of related pages under a certain topic. ",
"updated": 1609182145551
}
]
}
@@ -0,0 +1,34 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1613755348083
},
"paragraphs": [
{
"style": "Text",
"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 and properly mapping the name of the page in the name of the file.",
"updated": 1613755498049
},
{
"style": "Text",
"text": ""
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "5",
"type": "Docs Tutorial Name",
"definition": {
"text": "Refers to the name of the tutorial, which in turn is a collection of related pages.",
"updated": 1611000326995
},
"paragraphs": [
{
"style": "Text",
"text": "Tutorial names are used to group a set of related pages under a certain tutorial. ",
"updated": 1609182145551
}
]
}
@@ -1,15 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "6",
"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.",
"updated": 1611000559709
},
"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."
}
]
}
@@ -0,0 +1,16 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1613755594915
},
"paragraphs": [
{
"style": "Text",
"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
}
]
}
@@ -1,15 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "7",
"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
},
"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."
}
]
}
@@ -0,0 +1,16 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1613755729645
},
"paragraphs": [
{
"style": "Text",
"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
}
]
}
@@ -1,14 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "8",
"type": "Docs Concept 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."
}
]
}
@@ -0,0 +1,16 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1613757043006
},
"paragraphs": [
{
"style": "Text",
"text": "A paragraph may have a style, as explained in the Docs Paragraph Styles page.",
"updated": 1613757122601
}
]
}
@@ -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
}
]
}
@@ -1,14 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "9",
"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."
}
]
}
@@ -0,0 +1,42 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1613756218722
},
"paragraphs": [
{
"style": "Text",
"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": ""
}
]
}
@@ -1,15 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "10",
"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
},
"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."
}
]
}
@@ -0,0 +1,16 @@
{
"topic": "Docs Basics",
"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.",
"updated": 1613756750385
},
"paragraphs": [
{
"style": "Text",
"text": "The page of a concept is self-contained.",
"updated": 1613756891822
}
]
}
@@ -1,14 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "11",
"type": "Docs Paragraoh",
"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."
}
]
}
@@ -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 until the next block starts, or until the page ends.",
"updated": 1611001401401
}
]
}
@@ -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
}
]
}
@@ -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
}
]
}
@@ -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."
}
]
}
@@ -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."
}
]
}
@@ -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
}
]
}
@@ -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.",
@@ -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."
}
]
}
@@ -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."
}
]
}