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

docs.contract.reference

Resolve a contract into a documentation-ready reference.

  • Type: operation (query)
  • Version: 1.0.0
  • Tags: reference
  • File: packages/libs/contracts-spec/src/docs/queries/contractReference.query.ts
    • field.key.label
    docs.contract.reference
    field.version.label
    1.0.0
    field.type.label
    operation (query)
    field.title.label
    docs.contract.reference
    field.description.label

    Resolve a contract into a documentation-ready reference.

  • Type: operation (query)
  • Version: 1.0.0
  • Tags: reference
  • File: packages/libs/contracts-spec/src/docs/queries/contractReference.query.ts
    • field.tags.label
    reference
    field.owners.label
    field.stability.label

    Resolve a contract into a documentation-ready reference.

    Goal

    Expose a canonical reference view for any ContractSpec surface.

    Context

    Used by docs generators and UI to render consistent reference pages.

    Source Definition

    export const ContractReferenceQuery = defineQuery({
  meta: {
    key: 'docs.contract.reference',
    title: 'Contract Reference',
    version: '1.0.0',
    description: 'Resolve a contract into a documentation-ready reference.',
    goal: 'Expose a canonical reference view for any ContractSpec surface.',
    context:
      'Used by docs generators and UI to render consistent reference pages.',
    domain: DOCS_DOMAIN,
    owners: DOCS_OWNERS,
    tags: [...DOCS_TAGS, 'reference'],
    stability: DOCS_STABILITY,
    docId: [docId('docs.tech.docs-reference')],
  },
  capability: {
    key: 'docs.system',
    version: '1.0.0',
  },
  io: {
    input: ContractReferenceInput,
    output: ContractReferenceOutput,
  },
  policy: {
    auth: 'anonymous',
    pii: [],
  },
});