Cleaning up our GitHub Organization and Enhancing Documentation

Oliver Beddows
Lisk Blog
Published in
2 min readFeb 23, 2017

After revealing our plans for the Lisk SDK; we are preparing the next steps in order to start moving forward in terms of development. This involves archiving deprecated repositories and increasing visibility on the ones we actively work on. We have also consolidated and enhanced our documentation as you can read below.

Image courtesy of GitHub, Inc.

A new, temporary place for documentation

Started as a community effort the Lisk Wiki has developed into an extensive compendium for information regarding the Lisk ecosystem. We at the Lisk Foundation have set ourselves the goal to expand on this effort as much as possible. Consequently, we have moved all of the Lisk documentation to it. This includes our API, handbooks, technical reference, installation and upgrade guides.

For the future, we are researching different solutions which offer greater flexibility, features and a more user friendly approach. We will provide an update on that effort, once we know more.

Explaining the Lisk Protocol

The Lisk core is an extensive package of code and functionality. It’s based on the latest LTS version of Node.JS, uses military-grade cryptography and utilises PostgreSQL for the blockchain persistence layer.

The blockchain itself is composed of blocks, which itself are composed of a header and a list of confirmed transactions. These blocks are being generated every 10 seconds within the Lisk network using DPoS consensus.

Cryptographic tokens are held in accounts which are secured with a PKI and there are multiple options to enhance security even further, either with a second passphrase, multi-signature or both.

Additionally, there is a total of six functional transaction types and three more types which are currently working, but will be completely re-designed this year.

All of this, including network rewards and peers communication, are described in our Lisk Technical Protocol Reference which you can also find on the Lisk Wiki.

Archiving deprecated repositories

As part of the consolidation effort, we have created a new GitHub account called LiskArchive, which will house all deprecated repositories.

The deprecated repositories include:

Fresh example applications and documentation will accompany the re-designed applications SDK, which is currently a work-in-progress.

About the Author

Oliver Beddows is Founder and Vice President of the Lisk Foundation, with over 15 years of experience in development he oversees all projects involving the Lisk project as CTO. He is a husband, father, amateur time-trialist, open-source advocate, and works tirelessly to build a better future for Lisk everyday.

Contact Details

Twitter: @Karmacrypto
Email: oliver@lisk.io

If you enjoyed reading this, please log in and click “Recommend” below.
This will help to share the story with others.

--

--