From 2dfdacd65de818ee06bbe08ae1704e6a58a912f8 Mon Sep 17 00:00:00 2001 From: manumishra12 Date: Sat, 11 Jul 2026 14:28:28 -0700 Subject: [PATCH] okf: add optional .okfignore convention (SPEC 3.2) Adds an optional ignore-file convention so producers can mark files or directories that consumers and enrichment agents SHOULD skip when walking a bundle (drafts, scratch notes, large binaries). Uses gitignore-style patterns and never affects conformance: matching files are skipped, not forbidden. Additive and backward-compatible (per SPEC 11). Addresses #77. --- okf/SPEC.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/okf/SPEC.md b/okf/SPEC.md index 55d0a46c..02069bb0 100644 --- a/okf/SPEC.md +++ b/okf/SPEC.md @@ -109,6 +109,19 @@ frontmatter field in ยง4.1. OKF does not specify a separate file format for aggregating documents by tag; producers that want a tag-browsing view can synthesize one at consumption time by scanning frontmatter. +### 3.2 Ignore files (optional) + +An `.okfignore` file MAY appear at the bundle root, and โ€” applying to its own +subtree โ€” in any subdirectory. It lists gitignore-style path patterns, one per +line; blank lines and lines beginning with `#` are ignored. Consumers and +enrichment agents SHOULD skip files and directories matching a pattern when +walking the bundle โ€” for example drafts, scratch notes, or large binaries that +are not meant to be consumed as knowledge. + +An `.okfignore` never affects conformance: matching files are skipped, not +forbidden, so a bundle is equally valid without one, and a consumer that does +not implement ignore files MAY read the whole tree. + --- ## 4. Concept Documents