Skip to content
OKOKF Tools

Validation

OKF Tools separates three layers everywhere in the product:

  1. Conformance — does the bundle follow the OKF v0.2 specification? Checked by the Validator.
  2. Quality — is the bundle well structured, sourced, linked, and maintained? Checked by the Linter.
  3. AI readiness — is the knowledge likely to be easy for AI systems and agents to consume? An experimental, separately-labeled lens.

A bundle can be valid OKF but low quality and poorly maintained — that distinction is visible throughout the product, never merged into one score.

Official OKF specification requirement

Missing description, missing index.md, broken links, unknown types, and unknown fields are never conformance errors.

OKF Tools recommendation

The Linter offers four presets — Spec Only, Recommended, Strict, Enterprise — but only Spec Only determines OKF conformance. The others add optional guidance.

Diagnostic shape

interface Diagnostic {
  code: string;
  severity: "error" | "warning" | "info";
  path?: string;
  line?: number;
  field?: string;
  title: string;
  message: string;
  suggestion?: string;
  fixable?: boolean;
}

Every tool in the product renders this same shape, so results are consistent everywhere.