How to Create an OKF Bundle

Creating an OKF bundle is straightforward. You only need a directory, markdown files with YAML frontmatter, and optionally a git repository. No build tools, no configuration files, no SDKs.

Step 1: Create the Directory Structure

mkdir my-knowledge-bundle
cd my-knowledge-bundle

# Create your directory structure:
my-knowledge-bundle/
├── index.md               # Bundle entry point (recommended)
├── log.md                 # Changelog (optional)
├── getting-started.md     # Concept document
├── guides/                # Subdirectory for related concepts
│   ├── installation.md
│   └── configuration.md
└── references/            # Another subdirectory
    └── api.md

Step 2: Write a Concept Document with Frontmatter

Every concept document has two parts: YAML frontmatter (between --- delimiters) and a markdown body. Here is a minimal example:

---
title: Getting Started with My API
description: A quick tutorial on using the MyAPI endpoints
tags: [api, tutorial, quickstart]
version: "1.0"
author: Your Name
okf_version: "0.1"
---

## Overview

MyAPI is a RESTful service that provides [domain-specific functionality].

## Authentication

All API requests require an API key passed via the `X-API-Key` header.

## First Request

```bash
curl -H "X-API-Key: $API_KEY" https://api.example.com/v1/hello
```

## Next Steps

See the [API Reference](./references/api.md) for full documentation.

Required and Recommended Fields

• title (required) — Human-readable concept title.
• description (recommended) — Brief summary for agent discovery and search.
• tags (recommended) — Keywords for categorization. Good tags: okf, ai-agents, knowledge-base, tutorial.
• okf_version (recommended) — OKF spec version, currently "0.1".
• version (recommended) — Semantic version of this concept.
• author (optional) — Creator or maintainer name.
• depends_on (optional) — List of prerequisite concept slugs for cross-linking.

Step 3: Initialize Git and Publish

git init
git add -A
git commit -m "Initial OKF bundle"
git remote add origin https://github.com/your-username/my-knowledge-bundle.git
git push -u origin main

Step 4: Submit to BundleDex

1. Go to bundledex.net/submit.
2. Enter your GitHub repository URL.
3. Add a description and tags.
4. Your bundle will be reviewed and indexed within 24 hours.

Pro Tips

• Cross-link concepts with relative markdown links ([text](./related.md)) to build a knowledge graph.
• Keep concepts focused — one topic per file, well-organized.
• Use a log.md to track bundle updates and version history.
• Use OKFy to convert existing documentation into OKF automatically.
• Validate your bundle with okf-conformance or the Open Knowledge CLI.