Skip to main content

Documentation structure

The witboost documentation is organized into 4 main sections:

  1. User manual: guide to creating, handling and accessing data products.
  2. Architecture: components and features design.
  3. Platform: installation, configuration and customizations (e.g. custom template creation).
  4. API Reference: list of APIs needed to customize the platform

Other additional information for general understanding or installation notes can be found under:

  • Glossary: a dictionary of all the main concepts managed by the product.
  • Release Notes: a list of all the main features and issues fixed in the main witboost releases.
  • Requirements: a list of all the needed requirements to install the product.

Each section includes the content required by a specific subject. For instance, the User Manual includes everything you need to know from a data product developer and consumer perspective whereas the Platform section provides the information required by the platform team.