Knowledge Portal · engineering documentation

Skip to content

Federated from workspace · RP-002 · zaixos-registry/docs/contracts/PRODUCT_CONTRACTS.md Do not edit canonical truth here — update the source repo, then re-run npm run docs:sync.


ZAIXOS Product Contracts Index

Document type: Contract Index — Product
Version: 0.1
Status: Bootstrapped — entries Pending Registration
Classification: Internal — Registry Authority
Owner: Chief Product Officer (accountable) · Product Architects (co-owners)


Purpose

Index cross-module and public product contracts — module boundary contracts, public application services, and integration surfaces — by reference to product repositories.


Scope

| In scope | Product contract metadata and graph links | | Out of scope | Module implementation, Filament resources |


Responsibilities

RoleResponsibility
Product ArchitectAccurate contract index per product
Registry maintainerRegister on product registration

Authority

Contract definitions in product repos. Index only here.


Status

Pending Registration


Dependencies

DocumentRole
../catalog/PRODUCTS.mdProducts
PLATFORM_CONTRACTS.mdPlatform contracts consumed

Consumers

Cross-module integration, second product planning, architect reviews.


Entry schema

FieldDescription
contract_idPD-{nnn}
product_refPR-
contract_namePending Registration
source_pathProduct repo path — Pending
visibilityinternal, public, partner
registration_statusPending Registration

Catalog entries

contract_idproduct_refregistration_status
No entries — Pending Registration

Cross references

DocumentPath
SERVICE_CONTRACTS.mdService-level
../dependencies/DEPENDENCY_GRAPH.mdDependencies

Future evolution

TriggerAction
PR-001 RegisteredIndex module public contracts
Public API launchPD entries with visibility=public

Version history

VersionDateChange
0.12026-06-30Bootstrap — empty index

ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin