Skip to content

Reference

Canonical lookups — the "what does field X look like" docs.

Available

Doc What it covers
Prisma models Every field in every Prisma model — types, defaults, constraints, indexes
Environment variables Every process.env.* the codebase reads, with defaults and where used

To write next

  • api-internal.md — internal API endpoints (currently just /api/go/r/[retailerId]/p/[listingId])
  • s2s-postback.md — affiliate postback contract once defined in #17
  • scraper-fixtures.md — convention for retailer HTML fixtures used in tests

What goes here

  • API endpoints (request/response shapes, error codes)
  • Database / Prisma model field definitions
  • Environment variables
  • Third-party contracts (S2S postback, retailer feed formats)
  • Configuration knobs (mkdocs.yml, next.config.ts, etc.)

What does NOT go here

  • Why a model is shaped that way → ADR
  • How the system uses these models → Architecture
  • How to operate against these → Runbook