Skip to content

Getting Started

If you are new to the platform, start with the surface that matches your role:

Production and development are intentionally mirrored:

  • Production docs: https://docs.co2targettracking.co.uk
  • Development docs: https://dev.docs.co2targettracking.co.uk
  • Production API spec: https://api.co2targettracking.co.uk/openapi.json
  • Development API spec: https://dev.api.co2targettracking.co.uk/openapi.json

The live API reference page in this site picks the matching API environment at runtime, so dev.docs.* talks to dev.api.* and docs.* talks to api.*.

  1. Read API Overview to understand the gateway and contract shape.
  2. Open Live Reference when you need the current spec rather than a prose summary.
  3. Use Platform Inventory when you need to orient yourself in the monorepo or find the relevant bounded context.

This site is deliberately opinionated about ownership:

  • Live API behavior belongs to api.*.
  • User workflows belong to help.*.
  • Technical reference that can be generated should be generated here.