Skip to content

Contracts

Purpose

This folder contains the canonical contract artifacts for the Omnivoltaic front-end governance model.

Contracts here define:

  • content metadata structure
  • headless content structure
  • BFF calling rules
  • live marketing-data BFF surface
  • contact BFF submission contract
  • contact form workflow contract
  • article object contract
  • site intent schema

Governing Split

Every front-end experience should be understood as:

metadata + headless content + page behavior props

The key discipline is:

  • metadata defines layout and UI behavior only
  • headless content provides live domain payloads
  • app code consumes the contract and must not become the source of truth

No actual domain data should ever leak into metadata.

Core Contract Pages

For site intent, the page composition contract is:

  • pages.<pageKey>.theme
  • pages.<pageKey>.props

Scaffold consumers must translate only those registered definitions. They must not introduce alternate page-shape fields in generated app code or scaffold logic.

Compatibility Note

The canonical site-intent schema lives at:

  • docs/contracts/site-intent.schema.json

The legacy mirror remains at:

  • docs/intents/intent.schema.json

Scaffold consumers should read the canonical contract path first and use the legacy mirror only as transitional fallback.