refactor spec OKF

2026-08-01 09:34:12 +02:00
parent 81b825970a
commit 37432536dc
16 changed files with 595 additions and 10 deletions
@@ -0,0 +1,45 @@
+---
+type: Section
+title: Concept Documents
+sources: [SPEC.md]
+generated: true
+verified: false
+status: current
+stale_after: 2026-12-31
+---
+
+# Concept Documents
+
+A knowledge concept is a document containing metadata and content. It consists of two parts: **frontmatter** and **body**. The body is the main content.
+
+## Frontmatter
+
+Frontmatter is YAML enclosed between `---` delimiters at the start of the document, before any other text. All frontmatter keys MUST be lowercase.
+
+### Required Fields
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `type` | string | Must be one of: `Rule`, `Section`, `Example`, `Template` |
+| `title` | string | Human-readable title of the concept |
+
+### Optional Fields
+
+#### Provenance Family (`sources`)
+
+List of URIs or paths identifying sources used to produce this document. Values may reference files, URLs, or external resources.
+
+#### Trust Family (`generated`, `verified`)
+
+- `generated`: boolean — whether the document was produced by an automated system
+- `verified`: boolean — whether a human has reviewed the document's correctness
+
+#### Lifecycle Family (`status`, `stale_after`)
+
+- `status`: string — lifecycle status: `draft`, `current`, `deprecated`
+- `stale_after`: date-string — after which this document should no longer be relied upon
+
+### Conventions
+
+- Unknown additional frontmatter entries MAY be included
+- New conventional section headings can be added to bodies