Superalgos Beta 8
Building Crypto Trading Bots Becomes Easier with Superalgos Improved Feedback Loops
Superalgos Beta 8 brings in-app documentation and optimized trading bot feedback, dramatically improving the experience of building, testing, and debugging crypto trading strategies.
In-App Documentation
The Superalgos Documentation Website is soon to be discontinued as the documentation has moved inside the app! This strategic decision enables the system to better interact with the documentation, incorporating a new crucial element to the underlying infrastructure. The built-in documentation is searchable and organized into categories.
System-Wide Interactions
The whole system may now dynamically interact with the documentation. Let’s take a look at some of the new features!
Searchable Workspace
The workspace file is indexed and searchable, meaning that you can search for a node type, node name, or anything else for that matter, and the search results will include matches of all sorts, including matches in the code and configuration of nodes. You may find those matches under the Workspace tab!
Also, if you click on a node under the Workspace tab, you can have the design space automatically reposition on the selected node.
Deeper Technical Information
Every node type in the system features its own documentation page. Beyond the node definition and description, the system provides a wealth of technical details such as:
- Examples of the node’s configuration in the current workspace.
- A list of each of the items in the node’s menu along with their properties.
- A list of potential children nodes and their properties.
- A list of the types of nodes the node may be attached to.
- A list of the types of nodes the node may reference.
The information on these lists is extracted from the system’s schema files, thus are always up to date with the current version of the system. Also, the lists provide an additional navigation layer, as each item in the list features a tool-tip that may take you to the definition page of the target node.
Trading Bot Errors, Warnings, and Info
The ultimate use of the new in-app documentation feature comes from the Low-Frequency Trading Bot itself!
In Beta 8, when an error occurs during a trading session, the same error bullet you are used to is plotted on the charts, and the same red ring signals the node most related to the error.
When you point your mouse to the node or the error bullet, magic happens! The documentation tab opens up offering a human-written description of the error, plus contextual technical information that should help you identify and fix the causes of the error.
The same happens with warnings and info, which also include reading material to improve your understanding of why the warnings were generated.
Contributions
Superalgos is a Community-driven, open-source project and all users of the software are expected to contribute! If we all give back to the best of our abilities, Superalgos’ development will accelerate, and your own user experience — and ultimately, your trading performance — will improve. Don’t become a free-rider! It’s not cool!
Because the project understands that collaboration is the key to success, a new contribution feature was built into Beta 8!
Built-in Editor
The Documentation features a built-in editor, meaning that every page in the Docs may be edited by any user. In fact, users may create new pages, tutorials, upload images, link to videos, and everything that may help the community with the learning curve.
To edit a page, right-click on the paragraph you wish to update, select the pencil on the menu, and start editing! Use the escape key to exit edit mode, and that’s it! Make sure you explore the right-click menu for other features!
If you see a typo, a grammar error, or a paragraph that may be improved for clarity, please, do take the time to fix it and submit your contribution. It takes seconds or minutes, and does make a difference!
Multi-Language
In a move to prepare for growth and to cater to a wider user base, the documentation is also multi-language ready. If you’re fluent in any language other than English, you may also contribute by translating existing tutorials and documentation pages in general.
The footer of the Docs tab allows you to switch to a different language. Once you switch, the system automatically detects if the content you are browsing is available for the selected language. If it is, then it shows you the content in the selected language; if it isn’t, it shows you the content in English! You may then edit any English paragraph and translate it into the selected language. It’s that easy!
If you wish to translate to a language not currently listed, just let us know and we’ll add it for you!
Command Line
The search box in the Docs is also a new command-line interface. Most existing commands to this point have to do with managing the Docs and contributions but may be expanded to other uses in the future.
And here’s the magic of the new contributions feature: the app.contribute command takes care of all the Git witchcraft required to send your contributions in a Pull Request to the Superalgos repository in GitHub.com!
It doesn’t get easier than that! If Superalgos is of use to you, be a good citizen of the open-source world, and give back a minute or two of your time every day!
Also in the command-line arsenal is the app.update command! You guessed right! By running this ten-characters long command you may update your version of Superalgos to the latest version in the current branch!
Current Branch
Yes! You may also control which branch of the Superalgos repository you are working with and contributing to right from within the app! All you need to do is select the branch from the options available on the footer of the Docs tab.
New Contribute to Superalgos Tutorial
To learn how to use the new editing and contribution features, please do the new Contribute to Superalgos tutorial available in the Getting Started plugin workspace.
A Quick Advance on Upcoming Incentives
Superalgos will soon be moving into a new phase of development. The project will start incentivizing contributions and, rest assured, incentives will be retroactive.
The earlier in the life of the project you start contributing, the juicier your incentives will be, as the impact of contributions in a Community-driven project is clearly a function of time.
This is an open invitation for you to become a vested member of the community!
I wont say much about the nature of the incentives, but do the math… this is a crypto project with a grandiose vision, I’m sure you’ve noticed!
New Installation Requirements
For these new features to work as expected, a different set up is required for Superalgos Beta 8 in terms of the interactions with the Superalgos repository. The main difference is that you need to fork the Superalgos repository so that you may operate from within your fork.
Please follow the instructions on the README file, and welcome to Beta 8!
As usual, make sure you backup your work before proceeding!
