Introduction to BigLedger Akaun Documentation

Welcome to the BigLedger Akaun Platform documentation! This guide aims to provide you with comprehensive instructions on effectively using and contributing to the BigLedger Akaun Platform documentation. Whether you are a new user or an experienced document author, this guide will equip you with the knowledge and tools to create, manage, and collaborate on documentation effectively.

This comprehensive guide also aims to enable all users and stakeholders of the Akaun Platform, including retail customers, businesses, employees of Wavelet and BigLedger, third-party software developers, and third-party integrations to collaborate and produce a detailed handbook and blueprint that allows maximum knowledge sharing and collective creativity.

Objectives

The primary objectives of this documentation are as follows:

  1. Clear Organization: To achieve better control of permissions and access rights, the documentation is divided into multiple repositories. The Handbook and Blueprint may have different contributors, hence the need for separate repositories.

  2. Multiple Formats: The documentation is available in various formats, including single-page HTML, multi-page HTML, website, PDF, ePub, and DocBook. We use two different AsciiDoc compilers - Asciidoctor and Antora - to support these formats.

  3. Dynamic Content: Asciidoctor is used to compile ePub/PDF and basic HTML formats, but it lacks the ability to produce HTML output with a sidebar/header/menu easily. Additionally, Asciidoctor cannot dynamically pull content from multiple external repositories. To address this, we leverage Antora for generating the website with dynamic content.

The Output and Accessibility

The final output of the documentation is accessible at https://docs.akaun.com. Currently, this website is accessible to the public and hosted in an S3 bucket.

We also have a private documentation version accessible at https://playbook.akaun.com/bigdoc/index.html The use of extended path in the URL restricts access to Wavelet and BigLedger employees, making it suitable for private consumption.

Documentation Repositories

The documentation is organized into the following repositories:

Playbooks: https://github.com/akaun/Playbooks

The Playbook repository serves as a compilation point for content from both the BigLedger Handbook and BigLedger Blueprint repositories. During the "publishing" steps, content is extracted from these repositories to be included in the playbook.Refer to Playbook Guide for more details.

BigLedger Handbook: https://github.com/akaun/Public-Guide

The BigLedger Handbook repository contains comprehensive documentation for the Akaun Platform. Refer to the Handbook Guide for more details on contributing and using this repository.

BigLedger Blueprint: https://github.com/akaun/Private-Guide

The BigLedger Blueprint repository contains sensitive or private documentation for the Akaun Platform. Refer to the Blueprint Guide for more details on contributing and using this repository.

We encourage all users and contributors to familiarize themselves through Getting Started for a smooth and collaborative documentation process.