Documentation structure
The witboost documentation is organized into 4 main sections:
- User manual: guide to creating, handling and accessing data products.
- Architecture: a high-level description of the main components and features design.
- Glossary: a dictionary of all the main concepts managed by the product.
- API Reference: list of APIs needed to customize the platform
Other additional information for general understanding or technical requirements can be found under:
- 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, i.e. 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.