Help center
Frequently Asked Questions
Find answers to common questions about Open Knowledge Format, OKF tools, validation, and best practices.
General
FAQ
What is Open Knowledge Format?
Open Knowledge Format (OKF) is an open specification from Google Cloud for packaging curated knowledge as a directory of Markdown files with YAML frontmatter. It makes knowledge readable for both humans and AI agents.
Who maintains OKF?
OKF was published by the Google Cloud data team as an open, Apache-2.0 specification. The community contributes tools and implementations.
Is OKF v0.1 stable?
OKF v0.1 is in draft status. The core format is usable, but specifications may change as the community provides feedback and more implementations emerge.
Using OKF Tools
FAQ
How do I validate my OKF document?
Use the OKF Validator tool. Paste your Markdown content, and it will check required frontmatter, validation rules, and provide an OKF Score with detailed breakdown.
Can I batch generate OKF from Sitemap?
Yes. The Website to OKF Generator supports Sitemap mode. Enter a sitemap.xml URL and it will process up to 20 pages, generating a complete bundle with index, logs, and validation reports.
What is OKF Score?
OKF Score is a 0-100 metric that measures document quality across three dimensions: Structure (40%), Coverage (30%), and Connectivity (30%). Higher scores indicate better-structured, more complete knowledge.
How does the Live Badge work?
The Live Badge validates your deployed OKF document URL and generates an SVG badge showing the current OKF Score. You can embed it in README files or documentation to show real-time validation status.
Technical
FAQ
What frontmatter fields are required?
The only required field is 'type'. Recommended fields include title, description, id, tags, and source_url. Check the validator for warnings about missing recommended fields.
How do I improve my OKF Score?
Improve Structure by adding complete frontmatter (type, title, description, id, tags). Improve Coverage by writing detailed content with headings. Improve Connectivity by adding source_url and internal links.
Can I use OKF for commercial projects?
Yes. OKF is published under the Apache-2.0 license, which allows commercial use. You can use it for internal knowledge bases, product documentation, or public APIs.