Skip to content

Bundle an Open Knowledge Format (OKF) schema #143

Closed

Description

@mindsocket

Summary

Add a bundled schema for Open Knowledge Format (OKF v0.2) so an OKF bundle can be validated as a plain markdown space, with no plugin or custom parser.

OKF is a vendor-neutral format for knowledge: a directory tree (a bundle) of markdown concept documents with YAML frontmatter. Only type is required. Optional field families add provenance (sources), trust (generated, verified), lifecycle (status, stale_after) and a contract for Attested Computation concepts.

Prerequisite: keep frontmatter timestamps as written

OKF timestamps are ISO 8601 datetimes with offsets. The markdown reader turned unquoted YAML timestamps into Date objects and then truncated them to YYYY-MM-DD, and left Dates inside lists unconverted. Valid OKF documents therefore failed validation.

  • Load frontmatter and embedded YAML without YAML's timestamp type, so dates and datetimes stay as the strings written.
  • Add date-time and date-or-date-time formats alongside date.
  • Let the knowledge wiki's date fields accept either form.

Scope

  • schemas/_okf.json (partial: frontmatter $defs and rules) and schemas/okf.json (root schema).
  • Open type vocabulary: any type is accepted and unknown keys are tolerated, as OKF requires. Attested Computation additionally requires runtime.
  • Rules: description best practice, stale_after later than generated.at, usage_count needs a usage_window, and an Attested Computation must have a computation.

Out of scope (possible follow-ups)

  • Reserved files index.md and log.md: reported as excluded during parsing rather than validated or generated.
  • Resolving path-style markdown links (/tables/orders.md, ../x.md) between concepts. This is a general markdown reader gap, not specific to OKF.
  • Detecting a # Computation body section. The page body is stored as plain text, so the computation rule accepts either a computation field or any body content.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions