Add an OKF-conformant starter pack: ok seed --pack okf (also shown…#216
Merged
Conversation
…f`) (#1984) * docs(open-knowledge): OKF conformant starter pack spec (PRD-7119) Spec for adding an OKF-conformant starter pack as a normal STARTER_PACKS entry (ok seed --pack okf): type-bearing seed docs + frontmatter-free reserved index.md/log.md, pre-populated not enforced. Includes evidence, substrate map, and audit-corrected decisions. * feat(open-knowledge): OKF-conformant starter pack (PRD-7119) Add an `okf` entry to the `ok seed` STARTER_PACKS registry: a small mini-KB that is conformant with Google's Open Knowledge Format (OKF) v0.1 by construction. Every non-reserved seed doc carries a non-empty `type` (§9 rules 1-2); a lowercase, frontmatter-free `index.md` (§6 navigation) and `log.md` (§7 change history) follow the reserved-file conventions (§9 rule 3). Pure pre-populated content — the native frontmatter schema stays open-shaped, nothing is enforced or linted, and `ok init` is untouched. The pack reuses the pack-agnostic plan/apply/CLI/picker pipeline unchanged (only the registry literal + `PackId` union widen), so it auto-appears in `ok seed --list-packs`. Seeded links use standard markdown (a conformant OKF bundle's link graph is plain markdown; `[[…]]` is an OK superset the export normalizes away). Ships a guidance-only pack-local skill and an OKF §9 conformance test that runs the real seed pipeline and asserts all three rules over the written bytes (templates checked at their instantiated block-2 form), plus idempotent re-run. * fix(open-knowledge): address okf pack review (PRD-7119) Cloud-review feedback on PR #1984: - Widen `OkPackId` in the two desktop-bridge mirror sites (core + app) to include `okf` — the "update all three sites" invariant the bridge-contract Eq<> drift test guards. Fixes real client/server type drift (server sent `okf`; core/app types didn't model it). - PackCardGrid: add an `okf` icon (FileCheck) so it isn't visually identical to knowledge-base's Library; derive the loading-skeleton count from the icon map instead of a hardcoded 6; refresh the stale "Six-card" JSDoc. - Add a non-empty `type` to the okf pack skill — it installs as project-local markdown that OK admits into the content corpus, so without it the seeded project had a non-reserved doc lacking `type` (the pack's own contract). New conformance test covers the editor-skill-installed path. - Seed content uses standard markdown links everywhere (templates too); make the link-format comment accurate; drop `[[ ]]` from folder guidance. - log.md seeds a prose instruction (documents the dated-entry format) instead of a placeholder entry, matching peer packs and avoiding a stale seeded date. - Remove block-1 `tags:` from the templates (peers carry only title+description). - starter.test.ts derives the reserved-file set from the exported `OKF_RESERVED_FILENAMES` single source of truth. * fix(open-knowledge): sync okf skill log.md description + pin all §6 nav links Re-review follow-ups on PR #1984: - Update the okf pack skill's `log.md` description: the prose-only `log.md` change (no placeholder entry) left the SKILL.md still telling authors to "replace the placeholder date" on a file that no longer ships one. - Strengthen the §6 navigation conformance test to pin all four seeded standard-markdown links (welcome + the three section folders), not just `welcome.md`. --------- GitOrigin-RevId: 4dfa2e4aac7c01eecd4d39e3984c5545a69ec538
![inkeep-internal-ci[bot]](https://avatars.githubusercontent.com/u/123133689?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Automated approval from agents-private public-mirror-sync (run: https://github.com/inkeep/agents-private/actions/runs/27802843279). Source of truth is the monorepo; direct edits on inkeep/open-knowledge are overwritten on next sync.
|
|
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
2 participants
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.
Add an OKF-conformant starter pack:
ok seed --pack okf(also shown byok seed --list-packs) scaffolds a small knowledge base that is conformant with Google's Open Knowledge Format (OKF) v0.1 from the first commit — every non-reserved doc carries a non-emptytype, plus a frontmatter-free lowercaseindex.md(§6 navigation) andlog.md(§7 change history). Pure pre-populated content: the native frontmatter schema stays open-shaped and nothing is enforced or linted. Ships a guidance-only OKF conventions skill like every other pack.