Skip to main content

Start with the contract you can validate

KB Contracts is the authority for knowledge-artifact interoperability. The current machine-readable surface is intentionally narrow and verifiable offline.

I produce public knowledge artifacts​

  1. Describe the participant with kb.module@1.0.
  2. Publish a versioned knowledge-artifact schema.
  3. Emit one kb.knowledge_artifact_manifest@1.0 per promoted public product.
  4. Preserve source, record, artifact, and opaque producer references exactly.
  5. Declare the public seam and compatibility window in a Profile 1 claim.
  6. Check in valid and invalid fixtures and pass npm run contract:validate.

I consume public knowledge artifacts​

  1. Resolve schemas and the release through contracts/registry.json.
  2. Pin the release candidate's full source_commit and verify its file hashes.
  3. Validate the manifest before reading its payload.
  4. Treat producer-assigned IDs as opaque and case-preserving.
  5. Support the current and immediately previous final schema versions unless a longer window is declared.
  6. Do not read undeclared repository internals.

I am changing a contract​

Read ADR-0006, then follow the compatibility and migration policy. Required additions, removals, renames, semantic or identity changes, checksum changes, enum removals, cardinality changes, and document-meaning changes require a new schema version.

I am looking for run or operational standards​

They are not owned by this release. Run records, lifecycle, operational errors, environment evidence, retries, staging, promotion, and rollback remain producer-local or candidate operational guidance. Pages covering those subjects are retained and labeled so historical knowledge is not silently lost.

Fast paths​