Skip to main content
DudoxxSentinel
Sign in

Standards and formats

Knowledge bundles in the Open Knowledge Format

Sentinel turns a document it has read into a folder of plain markdown files in the open OKF format. Your team can open it, search it, archive it and hand it to an AI agent, with no Sentinel software needed.

What it is

An open format for knowledge in plain files

The Open Knowledge Format (OKF) describes a folder of text files that together hold what is known about a subject.

Open and tool-neutral

The format is published as an open specification. Any tool can read a bundle; no vendor holds the key.

Markdown with a small header

Each concept is one markdown file. A short YAML header at the top says what kind of concept it is, where it came from and when it was made.

Versioned

A bundle names the format version it follows, so a reader knows what to expect. Sentinel writes version 0.2.

Layout

What is inside a bundle

A bundle is a normal folder or zip file. The names below are the ones Sentinel writes; the format itself leaves the folder layout free.

Two file names are reserved by the format: the directory listing and the update log. Every other markdown file is one concept.
  • index.md — Directory listing and format version
  • log.md — What changed, and when
  • pages/ — One concept per page
  • figures/ — One concept per figure
  • tables/ — One concept per table
  • transcript.md — Spoken audio, written out as text
  • assets/ — Image crops, page images and region data

How Sentinel makes one

From upload to a checked bundle

You do nothing extra. The bundle is built from what Sentinel already read, and it is checked before you can use it.

  1. Upload

    You upload a document or a recording to Sentinel.

  2. Read the regions

    Sentinel splits each page into regions, such as text, figures and tables, and reads each one. A region it cannot read with confidence stays marked as unreadable, with its location kept.

  3. Write the concepts

    Every page, figure and table becomes a markdown concept. Each one records its page, its place on the page and where it came from. A human correction wins over the machine reading.

  4. Validate

    Sentinel checks the finished bundle against the format rules. A bundle that fails the check is not released.

  5. Index for search

    The text is cut into pieces and added to a search index, so your team can find a passage across all documents and open it at its page.

How a team uses it

One bundle, four jobs

Because a bundle is only files, it fits the tools you already have.

Retrieval for AI agents

An agent reads the directory listing, picks the concepts it needs and cites the page each fact came from.

Long-term archive

Plain text outlives software. A bundle stays readable in any editor, years from now.

Exchange

Send the zip to a partner or another system. It carries its own sources and history.

Validation

A check tool can confirm that a bundle follows the format before you rely on it.

Limits and honesty

What we claim, and what we do not

We want you to know exactly where our work ends and the standard begins.

  • No endorsement

    The format is an open specification published by its authors. Sentinel uses it. That does not mean its authors endorse or certify Sentinel.

  • The specification is theirs

    This page is a short guide, not the specification. For the exact rules, read the specification itself.

  • Document understanding is optional

    Bundles come from the document understanding feature, which your administrator must switch on first.

Read the specification: Open Knowledge Format on GitHub

Want bundles from your documents?

Tell us what you store and what you want to search. We show you a bundle made from your own documents.