Jaxkr / lisk-docs

📘 Lisk documentation repository

Lisk Docs

Lisk uses Antora as documentation generator.

Click here to see the live version of the Lisk Documentation.

How to contribute to the Lisk Documentation

Overview

Content

The Content of the whole Lisk documentation is stored in branches:

docs-sdk
docs-core
docs-protocol

Documentation for previous versions of the SDK and Core is stored in branches following the naming convention:

docs-core-VERSION
docs-sdk-VERSION
docs-protocol-VERSION

where VERSION is always referring to the corresponding software version.

UI

The presentation of the documentation is stored completely seperate form the actual content. It’s stored on the antora branch.

Building

The build branch stores the site.yml file, which is used to generate the Lisk Documentation using Antora.