Skip to content

fix: add missing OKF frontmatter to homepage example README - #33

Open
nahwan-kim wants to merge 1 commit into
changeroa:mainfrom
nahwan-kim:fix/example-readme-okf-frontmatter
Open

fix: add missing OKF frontmatter to homepage example README#33
nahwan-kim wants to merge 1 commit into
changeroa:mainfrom
nahwan-kim:fix/example-readme-okf-frontmatter

Conversation

@nahwan-kim

Copy link
Copy Markdown

scripts/validate-okf.mjs walks every Markdown file in the repo and treats anything that is not index.md/log.md as an OKF concept document, requiring frontmatter with a type. examples/stylegallery-homepage/README.md shipped in 0.1.4 without frontmatter, so repo validation and the Validate StyleGallery workflow (.github/workflows/validate.yml, node scripts/validate-okf.mjs --json) fail on main.

This adds the frontmatter block, matching the convention already used by README.md (type: Repository Guide) and consumer-reference/agent-native/README.md (type: Interface Guide). No prose or validator changes.

Verified locally on top of upstream/main (9049f13):

$ node scripts/validate-okf.mjs --json
{ "ok": true, "conceptCount": 110, "indexCount": 25, "logCount": 1, "failures": [] }

$ node scripts/test-validate-okf.mjs --json
ok: true

Not verified: the rest of validate.yml beyond the OKF steps.

- validate-okf.mjs treats every non index/log markdown file as an OKF concept, so the frontmatter-less example README failed repo validation and CI
- matches the frontmatter convention already used by README.md and consumer-reference/agent-native/README.md

Confidence: high
Scope-risk: narrow
Reversibility: clean
Tested: node scripts/validate-okf.mjs --json (ok, 0 failures), node scripts/test-validate-okf.mjs --json (ok)
Not-tested: full validate.yml workflow
@nahwan-kim
nahwan-kim requested a review from changeroa as a code owner August 29, 2026 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant