0. How to read this documentation

Use this page to choose the right documentation section before you start implementing.

Where to start

Read the sections in this order if you are new to the documentation:

1. Functional — Start here for context and high-level documentation. This section explains the product concepts and expected behavior before you work with the technical details.
2. Schema — Read this before implementation to understand the structure of the data, key objects, and how they relate to each other.
3. GraphQL — Use this section if you want to learn the basics of GraphQL or need help understanding how to query the API.
4. FAQ — Refer to this section when you have specific questions during implementation.

Documentation sections

Functional

Use the Functional section when you need context before making technical decisions. It provides high-level documentation about how the system works and what each feature is expected to do.

FAQ

Use the FAQ section when you run into a specific implementation question. This section is designed for quick answers while you are building or debugging.

GraphQL

Use the GraphQL section if you are new to GraphQL or need a refresher on the basics. It explains the concepts you need before writing or modifying GraphQL queries.

Schema

Use the Schema section before you start implementing. It explains the structure of the data so you can understand the available objects, fields, and relationships.

Functional section for context and high level documentation

FAQ for specific questions during implementation

GraphQL if you want to learn the basics of GraphQL

Schema before you start implementing to learn the structure of our data