docs(okf): move bundle to repo root and retire brief
The brief is fully captured in the bundle; it stays in git history. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
957a386b58
commit
64fef83314
22 files changed
+37
-153
No files matched your search
@@ -0,0 +1,24 @@
|
||||
---
|
||||
type: Decision
|
||||
title: Knowledge bundle lives at the repository root
|
||||
description: The repository root is the OKF bundle root; any other markdown file there needs frontmatter to stay conformant.
|
||||
tags: [decision, okf]
|
||||
status: stable
|
||||
generated: { by: claude-code/claude-opus-5-5, at: 2026-10-11T12:15:30Z }
|
||||
verified: { by: human:noel, at: 2026-10-11T12:15:30Z }
|
||||
---
|
||||
|
||||
# Decision
|
||||
|
||||
The OKF v0.2 bundle root is the repository root.
|
||||
|
||||
# Consequence
|
||||
|
||||
OKF requires frontmatter with a `type` in every non-reserved `.md` file in the
|
||||
bundle. Any other markdown at the root breaks conformance unless it carries
|
||||
frontmatter, for example:
|
||||
|
||||
- `README.md`: give it frontmatter (`type: Readme`) or skip it; `index.md` already does its job.
|
||||
- `CHANGELOG.md` from release-please: release-please writes it without
|
||||
frontmatter. Options: point release-please's `changelog-path` at a non-`.md`
|
||||
file, or accept that one file is non-conformant.
|
||||
Reference in new issue
Block a user