okf
OKF is knowledge as code: markdown files with YAML frontmatter organized in directories that both humans and agents can read from the same source. Use this skill to author bundles, migrate existing documentation, search and retrieve knowledge, validate structure, or maintain your project's knowledge graph as it evolves.
OKF lets you capture project knowledge as portable markdown bundles with YAML frontmatter for humans and agents to read together.
AI-generated summary based on this skill's SKILL.md
Install
serradura/okf-gem/okf · repository language: Ruby
git clone https://github.com/serradura/okf-gem
cp -r okf-gem/plugin/skills/okf ~/.claude/skills/okfFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I organize project knowledge as markdown files with OKF?
OKF organizes project knowledge as portable markdown bundles with YAML frontmatter. Each markdown file represents a concept or topic, prefaced with YAML metadata (title, tags, relationships). Files are grouped in directories by domain or function. This structure lets both humans and agents read from the same source, making knowledge searchable, versionable, and maintainable as code alongside your project.
What is the Open Knowledge Format and how do I set up a bundle?
Open Knowledge Format (OKF) is a specification for knowledge as code: markdown files with YAML frontmatter organized in a portable directory structure. To set up an OKF bundle, create a root directory, add markdown files with YAML headers (title, tags, links), and organize them by topic or service. OKF bundles are self-contained, version-controllable, and designed for both human reading and agent consumption.
How can I convert existing documentation into OKF structure?
OKF supports migration of existing documentation through structured conversion: extract content from your current docs, create markdown files for each concept or page, add YAML frontmatter with metadata (title, tags, relationships to other concepts), and organize files into a directory hierarchy. OKF's linting and validation tools help ensure conformance during migration, catching structural issues before your bundle goes live.
How do I search and retrieve knowledge from an OKF bundle?
OKF bundles enable fast retrieval without reading entire documentation. Search by concept name, tag, or semantic relationship through the YAML metadata. The bundle structure and frontmatter make it easy to locate specific knowledge, traverse related concepts via markdown links, and consume bundle content as context for agents or tools without loading everything at once.
How does OKF validate and lint bundle quality and conformance?
OKF provides validation and linting tools to curate bundle structure and enforce conformance rules. These tools check YAML frontmatter integrity, verify markdown syntax, validate link references, and detect structural issues. Regular validation ensures your knowledge bundle stays well-formed, searchable, and maintainable as it evolves, catching problems early before they degrade retrieval or agent consumption.
Can OKF model knowledge as emergent graphs through markdown links?
Yes. OKF models knowledge as emergent graphs by leveraging markdown links and semantic relationships defined in YAML frontmatter. As you link concepts together and tag them consistently, the bundle naturally forms a graph structure. This allows visualization of how ideas connect, discovery of related knowledge, and understanding of your project's conceptual landscape without manual graph construction.
SKILL.md
rendered from the published skill — quoted content, verbatim
Open Knowledge Format (OKF)
You are the OKF expert in this repository. OKF is knowledge as code: a directory of markdown files,
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 15 files
plugin/skills/okf/SKILL.md
plugin/skills/okf/playbooks/consume.md
plugin/skills/okf/playbooks/curate.md
plugin/skills/okf/playbooks/doctor.md
plugin/skills/okf/playbooks/maintain.md
plugin/skills/okf/playbooks/menu.md
plugin/skills/okf/playbooks/migrate.md
plugin/skills/okf/playbooks/produce.md
plugin/skills/okf/playbooks/refine.md
plugin/skills/okf/playbooks/search.md
plugin/skills/okf/reference/APACHE-2.0.txt
plugin/skills/okf/reference/SPEC.md
plugin/skills/okf/reference/authoring.md
plugin/skills/okf/reference/cli.md
plugin/skills/okf/templates/concept.md