On April 2, 2019, blockchain project Golem introduced a new documentation platform that would vastly help lower the barriers of entry for people looking to get into the project.
Razing the Entry Barriers
Golem is a blockchain-powered project that allows users to monetize their idle CPU and GPU power in exchange for GNT tokens. In its short history of almost three years, the project has been relatively successful in leveraging the Ethereum blockchain’s ability to support decentralized applications (dApps).
In a bid to lower the entry barriers for individuals who wish to know more about the project, developers and user experience designers at Golem have been working in close collaboration to come up with robust documentation standards. Both the teams have been working incessantly to find a standardized solution to store Golem’s exhaustive knowledge documents which exceed more than 180,000 lines of code.
In their blog post, the Golem team highlights that creating a single source of information for “All Things Golem” has always been high up on their priority list. The team adds that for a long time it has desired to merge high-level documentation available on Golem’s website with the more tech-heavy knowledge documents on their GitHub.
However, at the same time, the team didn’t want to develop the desired documents repository from ground zero as it would distract its developers from Golem’s long-term vision.
Fortunately enough, Golem found its savior in Docsify, an open-source simple and lightweight documentation platform that comes with a slew of plug-ins to enhance user experience.
Docsify trumps GitHub in that unlike the latter, it does not generate static HTML files. Instead, it parses the Markdown files and displays them as a website on the internet. This feature helps in saving space on the server and ensures quick webpage display.
Some of the other features of Docsify include multiple themes, emoji support, and compatibility with Internet Explorer 10 and above.
Golem’s new documentation repository can be found here.
The simple and pleasing look of the webpage makes it easy to navigate for users who might have found GitHub’s interface a bit confusing. It also displays basic details of the project like FAQs, use-cases, and roadmap, among other things.