Shipping Documentation

Helping people get started with Unlock.

Akeem Adeniji

 On November 15, 2019

Documentation is important as it allows thoughts and ideas to scale outside of its original context. Being an open source project with hopes that people will find value in our work; we recoginze the amount of impact having compentent documenation can having towards helping other to reach their goals.

As a starting point, we have begun by outlining the quickest way to get started with the project, and some highlevel info about the project's components.

We have also made a commitment to the following documentation strategy:

  1. End-user facing features require documentation to be considered shippable.
  2. Components intended to be used or extended by developers require documentation to be considered shippable.

While it is a work in progress, you can find our current documentation here.