OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

AI index

Build

Map contracts and codebase structure before generating or adopting surfaces.

The graph artifact contracts connect authored specs, implementation anchors, registry items, generated outputs, drift reports, and release evidence without mutating the repository.

Read-only graph checks

graph-drift
contractspec graph inspect --kind contract --json
contractspec graph inspect --kind codebase --json
contractspec graph export --kind contract --json
contractspec graph export --kind codebase --json
contractspec drift check --json
contractspec release check
bun test packages/libs/contracts-spec/src/graph-artifacts/index.test.ts packages/libs/contracts-spec/src/contract-registry/schemas.test.ts

Artifact envelopes

  • contract graph: authored contracts, versions, owners, and public compatibility surfaces

  • codebase graph: implementation anchors, package boundaries, generated files, and import edges

  • linked graph: edges between contracts, runtime code, docs, examples, and release capsules

  • generation plan: read-only proposals for docs, schemas, clients, or adoption follow-up

  • drift report: schema-versioned evidence for missing, stale, or inconsistent surfaces

Governance checks

  • Graph and drift commands are read-only; they should not apply implementation rewrites.

  • Registry schema parity includes policy, capability, job, and translation item types.

  • Release capsules should cite graph evidence when public contracts, generated docs, or codebase adoption paths change.

  • Connect review is required before turning graph proposals into risky writes.

Use this page with

Contract Intelligence

when converting an existing codebase into explicit contracts: intelligence proposes candidate surfaces, while graph artifacts prove whether those surfaces stay aligned over time.

Contract Intelligence

Release capsules

OSS docsbuildStart with OSS. Adopt Studio when you want the operating layer.
Previous

Contract Intelligence

Analyze, export, import, reconcile, and adopt candidate contracts from an existing codebase through dry-run-first CLI workflows.

Next

Validation and typing

Keep runtime validation and TypeScript types aligned from the same source definitions.

Why ContractSpec

Keep educational and comparison content reachable without letting it define the primary OSS learning path.

ManifestoContract-first APISpec-driven development