Introduction⚓︎
The documentation for the <BB>
building block is organised as follows…
- Introduction
Introduction to the BB - including summary of purpose and capabilities. - Getting Started
Quick start instructions - including installation, e.g. of a local instance. - Design
Description of the BB design - including its subcomponent architecture and interfaces. - Usage
Tutorials, How-tos, etc. to communicate usage of the BB. - Administration
Configuration and maintenance of the BB. - API
Details of APIs provided by the BB - including endpoints, usage descriptions and examples etc.
About <BB>
⚓︎
Description of the purpose of the BB.
Capabilities⚓︎
Summary of the capabilities of the BB.