SUPERALGOS GOVERNANCE
Documentation Team Proof of Value, November 2022
Creation of external documentation
Intro
Previously all the application documentation was only available in the app running on your local computer. Which, as you can imagine, is a bit limiting if you wanted to read up on a tutorial, data mine or seek some clarity on governance, you needed to run the full system. Not so easy on your phone or tablet lying in bed or sitting on the commuter train.
Now you can read all the documentation at the superalgos.org website, where ever you are — providing you have some internet connection.
The Goal
The theory was simple: port the existing webpage builder out of the app and into a separate process so instead of rendering a page onscreen it produced an html file in a directory. An addon was adding the ability for the process to be automated whenever documentation changes were made by the community.
The Result
All the documentation, including translations and search capabilities, have been migrated to a separate process. This process has the ability to be run locally or automated with GitHub Actions to generate a complete static HTML website. None of the existing documentation code was changed, and that documentation is still fully available in the app.
