OKF tutorial: build your first knowledge bundle

Step 1: choose one knowledge scope

Start with a narrow scope. A good first bundle might cover five important pages, three API endpoints, or one support workflow.

Do not start by converting everything. OKF works best when each file has a clear concept boundary.

Step 2: create a folder

Create a bundle folder with an `index.md` file at the root. The index file helps humans and agents see what is available before opening individual concept files.

• `bundle/index.md` lists sections and links.
• `bundle/pages/home.md` describes one page.
• `bundle/support/contact.md` describes one support route.

Step 3: write frontmatter first

Frontmatter is the structured block at the top of a Markdown file. In this guide, the validator checks `type`, `title`, `description`, and `tags` so your documents are useful for search and preview workflows.

Step 4: write a focused Markdown body

• Use headings for audience, facts, rules, examples, and citations.
• Use lists and tables where structure matters.
• Use ordinary Markdown links to connect related concept files.

Step 5: validate and review

Paste each file into the OKF validator on this site. The validator runs in your browser, which means pasted content is not uploaded to this website.

After validation, review the file for accuracy. A passing file can still contain outdated or unsupported claims.

Step 6: publish safely

• Remove private keys, personal data, and internal-only material before public hosting.
• Keep `resource` links stable.
• Add a review date or timestamp so stale files are easier to spot.