Read and Check an Open Knowledge Format (OKF) Bundle

Prisment opens an Open Knowledge Format (okf.md) bundle where it already lives—a folder of Markdown in your repository—and turns each concept's YAML front matter into a readable summary of its type, status, trust tier and freshness, shows what it links to and what links back to it, and checks the whole bundle in a review. Nothing is converted, uploaded or built first. It is free, needs no account, and reads your documents in place (how they are handled).

1. What is an Open Knowledge Format (OKF) bundle?

A bundle is a folder of UTF-8 Markdown files—one concept per file, such as a database table, a business metric or a runbook—each opening with YAML front matter in which type is the only required key. Google Cloud introduced the format (announcement, specification) so data teams, engineers and AI agents share one versioned, human-readable knowledge base in Git.

Two file names are reserved: index.md (a directory of concepts) and log.md (a newest-first history under ## YYYY-MM-DD headings). A bundle declares itself with okf_version in the front matter of its top index.md (optional; see the FAQ), and each concept—such as metrics/weekly-bookings.md—carries its metadata at the top:

---
type: metric
title: Weekly bookings
description: Classes booked per week, net of cancellations, by the week the class runs.
status: stable
stale_after: 2027-04-30T00:00:00Z
sources:
  - resource: /tables/bookings.md
    title: Bookings table
  - resource: /references/booking-policy.md
    title: Booking policy
generated:
  by: process:nightly-sync
  at: 2026-10-28T02:00:00Z
verified:
  - by: metric-check/0.3
    at: 2026-10-21T02:00:00Z
---

# Weekly bookings

Count the [bookings](/tables/bookings.md) whose status is not cancelled, grouped by the week the class starts, for [members](/tables/members.md) on any plan.

Prisment is an independent reader of the format. It is not made, certified or endorsed by Google or the OKF project.

2. Why do ordinary Markdown editors fall short on an OKF bundle?

Because the fields that say how far to trust a concept sit unread inside raw YAML, reverse links between concepts are invisible, and /-rooted bundle links break whenever a bundle is a subfolder. Agents read the YAML through scripts or MCP servers; a person in a text editor or on GitHub hits three blind spots:

• Silent trust and freshness decay: A stale_after date passes without a sign, and a concept rewritten by an automated sync (generated.at) days after someone last checked it (verified[].at) looks identical to one checked today.
• Broken / links in subfolders: A link written /tables/bookings.md means the bundle's top. When the bundle sits in docs/knowledge/, GitHub and standard previews read / from the repository's top instead.
• One-way reading: A table's file shows what it links to, never which metrics or guides link back to it.

3. What does Prisment show on a concept?

A summary line in place of the word Frontmatter: the concept's type and status, its derived trust tier, whether it changed since it was verified, whether it is still fresh, and its one-line description. The three trust tiers (Human-reviewed, Machine-confirmed, Unverified) are the specification's, read from verified. Changed since verified (generated.at later than the latest verified.at) is Prisment's own signal, shown beside the tier and never as one.

Open the card for every key, edited as before, with unknown keys and YAML comments kept.

4. How do you follow two-way links across a bundle?

Above a concept in Read and Review, a bar lists what it Links to—its sources and the concepts its body names—and what it is Linked from across the bundle, each by its concept title so a click opens it. The specification gives links no type, so the bar says links, not depends on. At its end, Verify adds your own human: entry to the concept's trust list, signed with an id you type once; Withdraw undoes it.

Inside a bundle, a / link starts at the bundle's top, so a bundle in docs/knowledge/ follows its own links, never a same-named file at the repository's top. In a local folder, opening a concept also reads the bundle's unopened subfolders so Linked from counts every concept.

5. How do you keep a bundle's index.md complete?

Added a concept and forgot to list it? Right-click its folder and choose Update index.md…: Prisment shows every line it would add and writes nothing until you press Add.

1. Right-click the folder and choose Update index.md… (Create index.md… if it has none).
2. Read the preview. Each concept sits under a heading for its type, with its title and description; subfolders go under Subdirectories.
3. Press Add. Every line already there stays; Prisment only adds.

6. How do you check a whole bundle before it ships?

Start a review, add the bundle's folders, and decide each finding as Intentional or Needs work before you approve—with no command-line linter to install.

1. Open the folder that holds the bundle with Open Local Folder, in Chrome, Edge or the desktop app.
2. Start a review. Open any concept, choose Review beside Read and Edit, name it and press Start review.
3. Add the whole bundle. From the panel's ⋯, open the review window; in Documents, press Choose documents and tick the bundle's folders.
4. Decide each finding in To decide: Intentional or Needs work, with a reason if you like.
5. Approve once everything is decided. The approval is saved in .review/ and names the exact versions you read.

A folder that does not read as a bundle gets no OKF finding, and a missing index.md is never one: the specification tolerates it. The questions are signals for a person to weigh, never hard errors.

7. Can people who do not use Git read the bundle?

Yes: export it as an Interlinked Wiki—a folder of linked HTML pages with a searchable sidebar—where each concept keeps its summary line and a bundle's / links work from wherever the pages are unzipped. Select the bundle in the file tree and choose Interlinked Wiki. A page says Fresh until or Stale since on the day it is opened, not the day it was exported. Each page fetches its stylesheet and runtime the first time it opens, as every export does.

8. How can you try a bundle right now—and where does it stop?

Choose Create New › Demo › Knowledge bundle (OKF) to make an eight-file sample bundle in your browser or in a new local folder; made in a folder, it arrives with a review of the whole bundle waiting, its three questions to decide. Prisment reads and checks a bundle; it does not extract schemas from a database, run a concept's SQL queries or say whether its content is right; the local assistant reads a concept as an ordinary document, never as an instruction. Details are in the guide: Open Knowledge Format bundles and reviewing documents. Open the workspace and open your bundle's folder, or try the OKF demo. To compare Prisment with six other viewers, see Best OKF Viewers, Compared.