OKF Validator
Paste the Markdown file and check frontmatter.
Open pageFile example
OKF file example
Copy this minimal OKF file example first, then review what each Markdown and YAML frontmatter field means.
Minimal OKF file example
An OKF file is a Markdown document with YAML frontmatter at the top. The example below is intentionally small so you can copy it, replace the resource URL, and validate the structure before expanding the body.
---
type: Documentation Topic
title: API rate limit policy
description: Explains the public rate limit rules, retry behavior, and related API documentation.
resource: https://openknowledgeformat.online/sample/api-rate-limits/
tags: [okf, api, rate-limits]
timestamp: 2026-06-21T00:00:00Z
---
# API rate limit policy
This file describes the stable knowledge a reader or AI agent needs before answering questions about API rate limits.
## Key facts
- Requests are limited per workspace and endpoint group.
- Retry behavior should follow the canonical API documentation.
- Support teams should escalate repeated limit errors to the API owner.
## Related links
- [OKF Validator](/okf-validator/)
- [API OKF template](/templates/api-okf-template/)What an OKF file contains
- A YAML frontmatter block between two
---lines. - A required
typefield that names the concept category. - Recommended fields such as
title,description,resource,tags, andtimestamp. - A Markdown body with a clear heading, facts, boundaries, links, and source notes.
- One durable concept per file instead of a mixed content dump.
YAML frontmatter fields
Field
Purpose
Example
type
Names the concept category.
Documentation Topictitle
Gives the file a readable display name.
API rate limit policydescription
Summarizes the file for previews and indexes.
Explains public API rate limit rules.resource
Points to the canonical page, asset, or stable identifier.
https://openknowledgeformat.online/docs/rate-limits/tags
Groups related files for browsing and filtering.
[okf, api, rate-limits]Markdown body structure
- Start with one H1 that matches the file concept.
- Use short H2 sections such as purpose, key facts, boundaries, examples, and related links.
- Keep source claims close to their source links or owner notes.
- Avoid mixing unrelated topics, policies, or endpoints in one file.
Common mistakes
- Leaving out
typebecause the title seems obvious. - Using a homepage URL as the resource for every file.
- Writing broad marketing copy instead of stable facts.
- Putting multiple concepts into one Markdown file.
- Treating a valid file shape as proof that the claims are correct.
How to validate the file
- Copy the example above into the OKF Validator.
- Replace title, description, resource, tags, and body content with your source material.
- Fix frontmatter errors before reviewing warnings.
- Check links and factual claims manually before publishing.
FAQ
Common questions
Is this an official OKF file example?
No. It is an unofficial learning example based on public draft concepts and this site's guide profile.
Does every OKF file need all fields shown here?
The draft centers on type. This site recommends title, description, resource, tags, and timestamp because they make files easier to preview and validate.
Can I use this example for a website page?
Yes. Change type to Website Page, point resource to the canonical URL, and describe one page per file.
Can I validate a full folder from this page?
Use the single-file OKF Validator for one file, then use the folder validator for multi-file bundles.
Related pages
Validate this example
Copy the OKF file, edit the source fields, and check it before adding it to a bundle.
Open OKF Validator