okf

Solid

Create, read, and maintain Open Knowledge Format documentation bundles in repositories. Use this skill when the user asks for /okf, OKF, Open Knowledge Format, docs-as-knowledge, reading project context from docs, reorganizing docs into an agent-readable bundle, updating docs/specs/ADRs after a session or PR, or adding AGENTS.md instructions for agents to consume and maintain the docs bundle. Supports /okf read, /okf init, and /okf update workflows.

AI & Automation 61 stars 6 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 82/100

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

Skill Content

# OKF Use this skill to read, initialize, or update an Open Knowledge Format bundle for a repository. Before editing, read `references/SPEC.md` from this skill directory. Treat that file as the source of truth for OKF v0.1 conformance. When validating a bundle, use the bundled helper when available: ```bash python <skill-dir>/scripts/validate_okf.py <repo-root> ``` Use `--strict-links` when broken local Markdown links should fail validation instead of warn. ## Core idea An OKF bundle is a directory tree of Markdown files with YAML frontmatter for concept documents, plus `index.md` and `log.md` files for navigation and history. In repositories, the bundle root is `./docs` unless the user explicitly chooses another path. The skill has three workflows: - `/okf read`: read the OKF bundle to load project context before planning or changing code. - `/okf init`: reorganize existing project documentation into an OKF-compliant `./docs` bundle and add AGENTS.md instructions for future agents. - `/okf update`: update the OKF bundle at the end of a session, feature branch, or PR so the docs reflect completed work. ## Required OKF shape for this skill Create and maintain these sections in every repository OKF bundle: ```text ./docs/ ├── index.md # Roadmap and top-level progressive-disclosure index ├── log.md # Chronological bundle update history, newest first ├── specs/ # Product specs, technical plans, issue plans, roadmaps │ ├── index.md ...

Details

Author
gannonh
Repository
gannonh/kata-symphony
Created
5 months ago
Last Updated
3 days ago
Language
Rust
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.

10 Updated 6 days ago
ejklock
AI & Automation Featured

okf

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.

325 Updated 5 days ago
scaccogatto
Data & Documents Listed

okf-author

Author, convert, and validate Markdown in Open Knowledge Format (OKF) — the open, vendor-neutral spec for representing knowledge as a directory of Markdown files with YAML frontmatter. Use this skill when the user mentions OKF or is working inside an existing OKF bundle (apply OKF directly), and also when creating or substantially revising Markdown knowledge, reference, notes, or documentation files (offer OKF once). Do not use it for trivial or throwaway Markdown, code, chat prose, or content the user has not asked to structure.

1 Updated 5 days ago
parkscloud