Skip to content

Commit 81a0de6

Browse files
committed
docs(schema): document type/description frontmatter in AGENTS_MD
1 parent a9c2dea commit 81a0de6

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

openkb/schema.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,13 @@
4848
- Use [[wikilink]] to link other wiki pages (e.g., [[concepts/attention]])
4949
- Standard Markdown heading hierarchy
5050
- Keep each page focused on a single topic
51-
- Do not include YAML frontmatter (---) in generated content; it is managed by code
51+
52+
## Frontmatter (managed by code — do NOT emit it in generated content)
53+
- Every summary/concept/entity page carries a non-empty `type:` — `Summary`,
54+
`Concept`, or a capitalized entity subtype (e.g. `Organization`). This is the
55+
one field OKF requires; consumers use it for routing/filtering/presentation.
56+
- `description:` — a single-sentence one-liner (the field formerly named `brief`).
57+
- Do not include YAML frontmatter (---) in generated content; it is managed by code.
5258
"""
5359

5460
# Backward compat alias

tests/test_schema.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
"""Tests for openkb.schema constants (wiki AGENTS_MD schema doc)."""
2+
from openkb.schema import AGENTS_MD
3+
4+
5+
def test_agents_md_documents_type_and_description():
6+
# The new OKF-aligned frontmatter fields must be documented.
7+
assert "type:" in AGENTS_MD
8+
assert "description:" in AGENTS_MD
9+
# The code-manages-frontmatter contract must remain intact.
10+
assert "managed by code" in AGENTS_MD

0 commit comments

Comments
 (0)