Skip to main content

Getting started

This website is produced using Docusaurus and deployed using Cloudflare Pages.

It will pick up any .md or .mdx files in the mono repo that are contained within the following folders

  • components
  • infrastructure
  • integrations
  • modules
  • services

We may add folders to this given the need but due to the set up we can continue to leave documentation close to the code that it describes.

Within the documentation folder itself in the monorepo, there is a docs folder that contains developer docs, including this one, to help you to get started with your environment setup, and help you to hit the ground running.

API Reference

The API Reference is generated using our OpenAPI Specifications that are kept in scripts/openapi/schemas. These are updated each time a build is run and committed to the repository, so there's no additional work needed to generate these for the docs.

Our APIs are organised as a number of resources group around common services including:

  • Auth
    • Authorisation and Authentication of users
  • Customers
    • Customer, Organisation, Business units and Connections
  • Geo
    • Country, Locations and other GEO related capabilities
  • Inventory
    • Commodities, Inventory records, Storage locations and Storage contracts
  • Trading
    • Open and Closed network Listings, Bids and Trading(Sales) contracts
  • System
    • Common system related capabilities including Cache, initialisation and files