Documentation index

Start with the training example, then prepare your own notes or connect an agent. Detailed contracts and library design are listed below.

Start here

• Quickstart
• Prepare existing Markdown
• Install and use the agent skill
• Connect MCP
• Maintain knowledge after changes
• Commands and APIs

Guides and technical documents

• README.md
• Git history backfill protocol (normative contract)
• Frozen offline retrieval comparison
• Go toolkit benchmarks (issue 015)
• ADR 0001: toolkit graph projection for OKF v0.2
• ADR 0002: Additive semantic operation tags in ChangeSet format v1
• ADR 0003: Explicit temporal revisions within OKF 0.2
• `okf init` CLI contract (normative contract)
• MCP concept queries (v1) (normative contract)
• Managed Markdown setup contract (normative contract)
• MCP mutation and trust boundary (normative contract)
• Preparing a v0.1 migration (normative contract)
• OKF v0.2 conformance matrix (normative contract)
• OKF v0.2 executable contract (normative contract)
• Section search v1 (normative contract)
• Connect MCP
• Validation in GitHub Actions
• OKF: project knowledge
• Knowledge upkeep
• Repository knowledge
• Move an OKF 0.1 bundle to 0.2
• Quickstart
• OKF reference
• Release engineering
• OKF agent skill
• Repository knowledge workflow (copy into AGENTS.md) (normative contract)
• Repository knowledge workflow (copy into CLAUDE.md) (normative contract)
• Working with knowledge
• examples/README.md
• skosovsky/okf-v0.2-instant graph projection (normative contract)
• skosovsky/okf-v0.2 graph projection contract (normative contract)
• Backfill OKF knowledge from Git (normative contract)
• Event analyst contract (normative contract)
• Maintain OKF knowledge after code changes (normative contract)
• Open Knowledge Format skill: reading edition (normative contract)
• Adversarial evaluation matrix — reading edition (normative contract)
• OKF authoring and reading (normative contract)
• Converting source material to OKF v0.2 (normative contract)
• OKF 0.2 examples — reading edition (normative contract)
• OKF MCP operations (normative contract)
• OKF 0.1 → 0.2 migration — reading edition (normative contract)
• OKF operational recipes — reading edition (normative contract)
• OKF 0.2 specification — instant profile (normative contract)
• OKF 0.2 specification — date profile (normative contract)
• Offline knowledge viewer
• Viewer regression fixture on Linux and macOS