Revert "Revert "Merge branch 'in-app-documentation' of https://github.com/Superalgos/Superalgos into in-app-documentation""

This reverts commit a70b142afa.
This commit is contained in:
Luis Fernando Molina committed 2021-01-06 12:13:42 +01:00
1 parent 3378a10d25
commit 66b71953d8
16 files changed
+46 -283

No files matched your search

@@ -1,36 +0,0 @@
{
"type": "The Docs Explained",
"definition": {
"text": "This book will walk you through everything you need to know about the Docs.",
"updated": 1609762580891
},
"paragraphs": [
{
"style": "Chapter",
"text": "Superalgos->I->Docs Basics->Read Chapter I to learn the basics concepts. They are the foundation that will let you understand the commands and styles explained later in this book.",
"updated": 1609763076399
},
{
"style": "Chapter",
"text": "Superalgos->II->Docs Commands->The Docs include a powerful command line interface that allows you to quickly fire commands from the search box. Dive into Chapter II to learn the details of each available command.",
"updated": 1609763122458
},
{
"style": "Chapter",
"text": "Superalgos->III->Docs Commands Errors"
},
{
"style": "Chapter",
"text": "Superalgos->IV->Docs Commands Messages",
"updated": 1609783744261
},
{
"style": "Chapter",
"text": "Superalgos->V->Docs Paragraph Styles"
},
{
"style": "Chapter",
"text": "Superalgos->VI->Docs Context Menu Actions"
}
]
}
@@ -3,5 +3,10 @@
"definition": {
"text": "A data formula is a device used to assign a value to the panel data, usually in the form of the name of the corresponding record property."
},
"paragraphs": []
"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,3 +1,12 @@
{
"type": "Nodes Highlights"
"type": "Nodes Highlights",
"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."
}
],
"definition": {
"text": "Right click to edit this text and replace it with a definition / summary for this page. ESC to exit edit mode."
}
}
@@ -18,52 +18,18 @@
},
{
"style": "Title",
"text": "Configuring Panel Data"
"text": "Panel Data Configuration",
"updated": 1609860920089
},
{
"style": "Text",
"text": "Select Configure Panel Data on the menu to access the configuration."
},
{
"style": "Text",
"text": "{"
},
{
"style": "Text",
"text": " \"valueDecimals\": 2"
},
{
"style": "Text",
"text": "}"
"style": "Subtitle",
"text": "Properties",
"updated": 1609860933462
},
{
"style": "List",
"text": "valueDecimals sets the number of decimals to be shown on the corresponding data field."
},
{
"style": "Text",
"text": "{"
},
{
"style": "Text",
"text": " \"labelText\": \"The Label\","
},
{
"style": "Text",
"text": " \"labelPosition\": 15,"
},
{
"style": "Text",
"text": " \"valuePosition\": 20,"
},
{
"style": "Text",
"text": " \"valueDecimals\": 2"
},
{
"style": "Text",
"text": "}"
},
{
"style": "List",
"text": "labelPosition and valuePosition represent the vertical distance of the corresponding fields to the top margin of the panel."
@@ -1,3 +1,12 @@
{
"type": "Record Values"
"type": "Record Values",
"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."
}
],
"definition": {
"text": "Right click to edit this text and replace it with a definition / summary for this page. ESC to exit edit mode."
}
}
@@ -30,11 +30,8 @@
},
{
"style": "Title",
"text": "Configuring Style Condition"
},
{
"style": "Text",
"text": "Select Edit Condition on the menu to access the configuration."
"text": "Style Condition Configuration",
"updated": 1609860654525
},
{
"style": "Text",
@@ -45,7 +42,7 @@
"text": "To continue the example of the Percentage Bandwidth plotter, the following is the condition that determines the newly added styles:"
},
{
"style": "Text",
"style": "Javascript",
"text": "record.previous.movingAverage > record.movingAverage"
},
{
@@ -57,28 +54,9 @@
"text": "The definition of secondary styles is slightly different from that of the default style, as—in such cases—the atMousePosition property may no longer be defined:"
},
{
"style": "Text",
"text": "{"
},
{
"style": "Text",
"text": " \"opacity\": 0.55,"
},
{
"style": "Text",
"text": " \"lineWidth\": 1,"
},
{
"style": "Text",
"text": " \"lineDash\": [0,0],"
},
{
"style": "Text",
"text": " \"paletteColor\": \"UI_COLOR.RED\""
},
{
"style": "Text",
"text": "}"
"style": "Json",
"text": "{\n \"opacity\": 0.55,\n \"lineWidth\": 1,\n \"lineDash\": [0,0],\n \"paletteColor\": \"UI_COLOR.RED\"\n}",
"updated": 1609860800267
}
]
}
@@ -1,7 +1,8 @@
{
"type": "Trading Bot",
"definition": {
"text": "A trading bot is a computer program that—based on datasets exposed as products by other bots (counting sensors, indicators and even other trading bots)—applies the trading logic defined on a trading system to, on one side, generate a complete trading simulation (outputting datasets that include trades, the action of strategies, validation of conditions, etc.), and on the other side, manage the execution of orders when on a forward testing or live trading session."
"text": "A trading bot is a computer program that—based on datasets exposed as products by other bots (counting sensors, indicators and even other trading bots)—applies the trading logic defined on a Trading System to, on one side, generate a complete trading simulation (outputting datasets that include trades, the action of strategies, validation of conditions, etc.), and on the other side, manage the execution of orders when on a forward testing or live trading session.",
"updated": 1609861419818
},
"paragraphs": [
{
@@ -30,11 +31,8 @@
},
{
"style": "Title",
"text": "Configuring Trading Bot"
},
{
"style": "Text",
"text": "Select Configure on the menu to access the configuration."
"text": "Trading Bot Configuration",
"updated": 1609861438022
}
]
}
@@ -14,7 +14,8 @@
},
{
"style": "Text",
"text": "Notice that, in the context of Superalgos, a trading bot has nothing to do with the trading logic. Think of trading logic as the business rules which—in Superalgos—are defined in trading systems. Anyone may build trading systems, meaning that creating a trading system and the trading strategies within does not require coding."
"text": "Notice that, in the context of Superalgos, a trading bot has nothing to do with the trading logic. Think of trading logic as the business rules which—in Superalgos—are defined in trading systems. Anyone may build a Trading System, meaning that creating trading systems and the trading strategies within does not require coding.",
"updated": 1609861342619
},
{
"style": "Text",
@@ -26,11 +27,8 @@
},
{
"style": "Title",
"text": "Configuring Trading Mine"
},
{
"style": "Text",
"text": "Select Configure on the menu to access the configuration."
"text": "Trading Mine Configuration",
"updated": 1609861240385
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "App Commands Errors",
"pageNumber": "1",
"type": "App Error Contribution Not Sent",
"definition": {
"text": "There was a problmen trying to send your contribution to your fork of the Superalgos repository.",
"updated": 1609859551082
},
"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. 2",
"updated": 1609860582103
}
]
}
@@ -1,70 +0,0 @@
{
"topic": "App Commands Errors",
"pageNumber": "2",
"type": "App Error Github Credentials Missing",
"definition": {
"text": "In order to manage contributions from within the app, you first need to provide your Github.com credentials so that we can get authenticated when pushing your changes to the remote repository.",
"updated": 1609855182001
},
"paragraphs": [
{
"style": "Anchor",
"text": "Anchor Github Credentials Missing",
"updated": 1609855373585
},
{
"style": "Error",
"text": "Github Crendentials are Missing. Please solve this issue and try again."
},
{
"style": "Text",
"text": "At the root folder of Superalgos, you will need to create a JSON file called Github.json. Use simple text editor like notepad and configure there your Github credentials. You can copy and paste the following template, replacing the dummy strings with your actual user name and password.",
"updated": 1609856366366
},
{
"style": "Title",
"text": "Github File Template",
"updated": 1609856386094
},
{
"style": "Javascript",
"text": "{\n \"user\": \"Your Github.com Username\",\n \"password\": \"Your Github.com Password\"\n \"repository\": \"\"\n }",
"updated": 1609857106444
},
{
"style": "Title",
"text": "Properties",
"updated": 1609857199167
},
{
"style": "List",
"text": "user: Your Github.com Username."
},
{
"style": "List",
"text": "parrword: Your Github.com Password."
},
{
"style": "List",
"text": "repository: The URL of your Superalgos fork."
},
{
"style": "Title",
"text": "Example"
},
{
"style": "Javascript",
"text": "{\n \"user\": \"john-smith\",\n \"password\": \"john123$\"\n \"repository\": \"github.com/john-smith/Superalgos\"\n }",
"updated": 1609857447825
},
{
"style": "Note",
"text": "Don't worry, your crendentials will not be uploaded to the repository because the file Github.json is listed at the .gitignore file, so it will be ignored and will only be at your local computer."
},
{
"style": "Important",
"text": "The system will use your credentials only to execute a git push command pointing to your Superalgos repository fork, in order to upload all the changes you made to Docs Pages.",
"updated": 1609856824492
}
]
}
@@ -1,14 +0,0 @@
{
"topic": "App Commands Messages",
"pageNumber": "1",
"type": "App Message Contribution Succeed",
"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": "17",
"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
},
"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
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "Docs Basics",
"pageNumber": "18",
"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
},
"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
}
]
}
@@ -1,7 +1,7 @@
{
"topic": "Docs Commands Messages",
"pageNumber": "1",
"type": "Docs Message Saving Succeed",
"type": "Docs Message Saving Succed",
"definition": {
"text": "The docs.save command you executed was successful and all changes have been saved at the Superalgos Client.",
"updated": 1609783244197
@@ -1,16 +0,0 @@
{
"topic": "Docs Commands Messages",
"pageNumber": "2",
"type": "Docs Message Reindexing Succeed",
"definition": {
"text": "The docs.reindex command you executed succesfully rebuilt the Docs Search Engine Index.",
"updated": 1609783396612
},
"paragraphs": [
{
"style": "Success",
"text": "The index was rebuilt and now includes all the latest changes you have made since you open the UI or since the last time you executed the docs.reindex command. That means that new content created now should affect the search results. Also, changes in the Workspace have been applied to the index too.",
"updated": 1609783508213
}
]
}
@@ -1,16 +0,0 @@
{
"topic": "Docs Commands Messages",
"pageNumber": "3",
"type": "Docs Message Deleting Succeed",
"definition": {
"text": "The docs.delete command you executed successfuly delete the page you requested.",
"updated": 1609783558007
},
"paragraphs": [
{
"style": "Success",
"text": "The page was removed from the in-memory collection of pages, but it is still indexed at the Docs Search Engine Index, and it still exist on disk. To remove it from the index you need to execute docs.reindex and to remove it from disk, you need to execute docs.save. ",
"updated": 1609783652507
}
]
}