okf

Solid

Author, maintain, and consume Open Knowledge Format (OKF) knowledge bundles — portable markdown + YAML frontmatter that both humans and agents read. Use when capturing project knowledge (services, APIs, schemas, metrics, runbooks, decisions) into an OKF bundle, when updating one after code or docs change, or when a repository contains an `.okf/` (or other OKF) bundle that should inform the task. Triggers on: "document this in OKF", "update the knowledge bundle", "capture this as a concept", or any work in a repo that has an OKF bundle.

AI & Automation 93 stars 17 forks Updated today MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
66
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Open Knowledge Format (OKF) skill OKF represents knowledge as a directory of markdown files with YAML frontmatter. It is minimal by design: no schema registry, no runtime, no SDK. Your job is to produce, maintain, and consume OKF bundles **conformant with the spec**, not your memory of it. **Always read the canonical spec before non-trivial work:** [reference/SPEC.md](reference/SPEC.md). It is the verbatim OKF v0.2 specification and the source of truth for every rule below. ## The one hard rule A bundle is conformant (§11) iff: every non-reserved `.md` file has a parseable YAML frontmatter block, and every such block has a **non-empty `type`** field. Everything else is soft guidance. Consumers MUST tolerate missing optional fields, unknown types, and broken links — never reject a bundle over them. ## Conventions to apply - **One concept = one file.** The file path (minus `.md`) is the concept ID. - **Frontmatter:** `type` is required. Add `title`, `description`, `tags` when they aid consumption; add `resource` (a canonical URI) only for concepts bound to a real asset — omit it for abstract concepts. - **Body:** prefer structural markdown (headings, tables, lists, fenced code). Conventional headings: `# Schema`, `# Examples`, `# Computation`. - **Cross-links:** standard markdown links; prefer absolute bundle-relative form (`/services/auth-api.md`). A link asserts a relationship; its *kind* lives in the surrounding prose, not the link. - **Reserved files:** `i...

Details

Author
scaccogatto
Repository
scaccogatto/okf-skills
Created
1 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

okf-knowledge-format

Author and validate knowledge as OKF (Open Knowledge Format) bundles — a directory of markdown files with YAML frontmatter, where every concept is one .md file with a REQUIRED `type` field, reserved index.md/log.md files, bundle-relative cross-links, and a permissive conformance model. Use when standing up or maintaining a knowledge bundle/catalog, writing or normalizing a concept document's frontmatter, deciding how to structure markdown knowledge for agents to consume, or checking a corpus against OKF conformance. The canonical spec is vendored under reference/SPEC.md and refreshed from GitHub via scripts/update-spec.sh.

8 Updated 3 days ago
ejklock
API & Backend Listed

okf-authoring

Use when creating, maintaining, consuming, converting, or validating Open Knowledge Format bundles, especially Otto Vault documentation for repositories, services, APIs, data assets, decisions, runbooks, metrics, and references.

0 Updated today
itzikiusa
Data & Documents Solid

okf-wiki

Scaffold a new Open Knowledge Format (OKF) knowledge base and populate it from existing material: a tree of small markdown concept files with YAML frontmatter, a spec, a validator, and session-start hooks that orient Claude on the knowledge base before it works. Use when the user wants to start an OKF atlas/wiki/knowledge base, build one from existing docs, plans, notes, or a repo, structure docs as one-concept-per-file with provenance, or initialize OKF in a repo (optionally into its GitHub wiki).

341 Updated yesterday
jamditis