feat: OKF-aligned frontmatter standard for docs + workflow files#267
Merged
Conversation
Adopt Google's Open Knowledge Format (OKF) — YAML frontmatter (type + title/ description/tags) over a markdown body — so a VibeFrame project reads as an agent-consumable knowledge bundle, and docs/ is Mintlify-ready in one move. - Add a shared extractFrontmatter() helper (frontmatter.ts) and route the storyboard + design parsers through it (was three duplicated regexes). The DESIGN validation path keeps its own parse (it needs the invalid-vs-not-map error signal). Behavior-preserving — full CLI suite green. - Scaffold STORYBOARD.md/DESIGN.md now carry OKF 'type'. - OKF frontmatter on all docs/*.md; cli-reference gets it via the generator HEADER (deterministic, gen:reference:check stays green). - Add docs/docs.json (Mintlify navigation), docs/index.md (OKF bundle listing), and docs/okf.md (assessment of VibeFrame-as-OKF-bundle).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adopt Google's Open Knowledge Format (OKF) — frontmatter (
type+ title/description/tags) over a markdown body — so a VibeFrame project reads as an agent-consumable knowledge bundle, and docs/ becomes Mintlify-ready in the same move (OKF title/description = what Mintlify needs).extractFrontmatter()(frontmatter.ts) consolidates the storyboard + design frontmatter extraction (previously 3 duplicated regexes). DESIGN validation keeps its own parse (needs invalid-vs-not-map error codes). Behavior-preserving — full CLI suite green (1300 tests).type.docs.json(Mintlify nav),index.md(OKF listing),okf.md(the assessment / 파악 deliverable).Verified: build, lint, full test, gen:reference:check, agent-sync:check all green; scaffold smoke confirms type + parse.