Files
OKF_CV_Website/decisions/bundle-at-root.md
T
Noel SabiaandClaude Opus 5.5 64fef83314 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>
2026-10-11 14:22:03 +02:00

25 lines
924 B
Markdown

---
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.