OKF Validator
Repair one Markdown file first.
Open pageBundle guide
Validate an OKF bundle before publishing
Validate an OKF bundle before publishing with three layers: a single-file check, a folder check, and source owner review. Passing structure checks does not prove the facts are current.
Short answer
Validate structure with tools, then validate facts with source owners.
What an OKF bundle validation should check
- Put related Markdown files in one local folder.
- Keep one concept per file.
- Add an
index.mdfile that explains scope and links to important files. - Check frontmatter fields such as
type,resource,tags, and timestamps. - Review relative links and duplicate resources before publishing.
- Remove secrets, private keys, private customer data, and unreviewed policy text.
Bundle validation workflow
- Check a representative file in the single-file validator.
- Open the folder validator.
- Select the local folder that contains your Markdown files.
- Fix missing frontmatter and missing type errors first.
- Resolve duplicate resources, missing index warnings, and relative-link warnings.
- Review source accuracy with the owner before publishing.
File, folder, and source review checklist
Check
Tool
Failure handling
Evidence label
Markdown files exist
Folder validator
Select `.md` or `.markdown` files.
reported
index.md exists
Folder validator
Add a root index file that declares scope.
reported
Each file has frontmatter
OKF Validator
Fix YAML before reviewing links.
reported
Each file has type
OKF Validator
Add a concept label such as Website Page or API Endpoint.
reported
Resources are not duplicated
Folder validator
Merge overlapping files or split concepts clearly.
reported
Relative links resolve
Folder validator
Fix paths or add target Markdown files.
reported
Source claims are current
Manual review
Check facts with the source owner.
pending
Private fields are excluded
Manual review
Remove secrets, private records, and restricted policy text.
reported
Common bundle failures
Finding
Repair path
Next page
Missing frontmatter or type
Repair the single Markdown file before reviewing the rest of the bundle.
Invalid tags or blank resource
Fix metadata shape so previews, search, and review notes stay useful.
Duplicate resource
Merge overlapping files or make the concept boundary explicit.
Broken internal link
Add the missing Markdown file or correct the relative path.
Sample bundle shape
bundle/
index.md
pages/home.md
pages/pricing.md
api/create-customer.md
support/refund-policy.mdPublishing review
- Confirm every resource points to a canonical source.
- Confirm each title and description matches the actual source.
- Confirm examples, limits, policy claims, and owner names are current.
- Keep video references as visual context only unless they are the factual source.
What validation cannot prove
This site is an unofficial OKF guide. The browser folder validator reads files selected by the user. It does not upload the bundle, run a server-side crawler, fetch URLs, certify official conformance, or prove that factual claims are current.
v0.2 trust review
- Review provenance, `sources`, `status`, and `stale_after` with the source owner before publishing.
- Do not treat optional metadata as proof that facts are verified or that a bundle is officially conformant.
Visual background
This video is included as visual background for OKF learning demand. It is not evidence that this page proves official OKF conformance.
FAQ
Common questions
Can I validate private folders?
The current page reads files in the browser, but you should still avoid using online pages for secrets or confidential records.
Does folder validation replace source review?
No. It checks structure and some file relationships, not factual truth.
Should I publish a bundle without index.md?
No. Use index.md to declare scope, owners, and the most important links.
Where should I go after a failed check?
Fix single-file errors in the OKF Validator, then use common OKF validation errors for repair order.
Related pages
Run a folder check
Start with the sample bundle, then select your own local Markdown folder.
Open Folder Validator