samples: add skill_reference_layer — a skill collection's reference layer as an OKF bundle - #313
Open
gamerey43 wants to merge 3 commits into
Open
Conversation
… as an OKF bundle A worked example of a skill collection's reference layer packaged as an OKF v0.2 knowledge bundle, demonstrating the bundle pattern on the largest producer of agent-read markdown in the wild: skill collections. Bundle contents: - 21 typed concepts in 6 type groups (Skills, Probes, Models, Templates, Doctrine, Playbooks), each carrying the OKF trust family (generated, verified, sources) - index.md: progressive-disclosure listing grouped by type - log.md: dated directory history - decisions.md: 6 inline decision record blocks (type: Decision Record per OKF spec, with the four-key shape: context/notes/boundary/invariant) OKF v0.2 conformance: every concept has parseable YAML frontmatter with non-empty type, the trust family is two-event, sources resolve inside the bundle, index.md groups by type. Reserved filenames (index.md, log.md) follow §8/§9. Recipe (samples/skill_reference_layer/README.md): documents how the bundle was produced, what's reproducible, the strict leakage guard (no real-world skill collection vocabulary), and the type taxonomy. Companion (separate issue, not part of this PR): a v0.3 proposal that argues for a Skill concept type with conventional shape and trust defaults.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
…ip conditions as a section; fold into Algorithm step 0; add D-007)
The OKF v0.3 Skill-type proposal was revised after a real-world seal
of twelve SKILL.md files shipped against the proposed shape. Five
concrete changes - drop Skip conditions as a top-level section,
downgrade Common mistakes to MAY, drop Examples as a section,
tighten verified.process to structural-only, sharpen the Playbook
vs Skill distinction by routing. This sample carries the changes
forward so the recipe and the proposal stay aligned.
Skill body change (applied to all six skills):
- Drop the dedicated `## Skip conditions` section.
- Fold the skip content into a new Algorithm step 0:
`0. If the question does not apply, emit no surface applies -
skipping and stop. Specific to this skill: <list>`
Decisions (companion block D-007):
- The reduction is a producer-side change; record the decision in
the bundle's decision file so the audit aligns with the proposal's
five-row "refined against the seal" table.
- target boundary: every concept file under bundle/skills/ removes
its `## Skip conditions` section; the skip content folds into
Algorithm step 0. The proposal's revision keyword for navigation
is `OKF as-is` for the reference layer - the bundle already
conforms.
- machine-enforceable invariant: a `## Skip conditions` section
does not appear in any skill file under bundle/skills/; every
skill file's # Algorithm carries step 0 with the folded skip
content.
README tightening:
- Add a "Body section reduction (Skill concepts)" sub-section that
names the six-section recommendation (Doctrine, Algorithm, Judge
rubric, Provenance as SHOULD; Common mistakes, Examples as MAY)
with the skip-conditions fold rule.
Verification (run locally):
- 24/24 concept files in bundle/ parse as strict YAML frontmatter
with the full trust family.
- 0 grillworks vocab hits in samples/skill_reference_layer/ (no
leak from the working collection).
- 6/6 skill files carry Algorithm step 0 with the folded skip
content; 0/6 carry a `## Skip conditions` section.
Co-Authored-By: Codebuff <noreply@codebuff.com>
The story: the seal-verifier's link phase — the structural pass extended to resolve internal sources[].resource values — flagged two paths in the sample bundle that did not resolve from the referring files' directories. Both carried a three-dot prefix that read as a path outside the bundle: - playbooks/cold-start.md: .../skills/bootstrap.md -> ../skills/bootstrap.md - templates/decision-record-block.md: .../skills/decide.md -> ../skills/decide.md One movement, fix and record together: - decisions.md accepts D-008: every internal sources[].resource is relative to the referring file's directory and resolves; the machine-enforceable invariant is the structural pass staying green over bundle/. - log.md records the 2026-08-18 update: the link fix and the pass that caught it. Verification (run locally): - seal-verifier passes over samples/skill_reference_layer/bundle — parse, frontmatter, link resolution structural-clean. - Zero three-dot prefixes remain; every internal source resolves. Generated with Codebuff 🤖 Co-Authored-By: Codebuff <noreply@codebuff.com>
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
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.
What this PR adds
A worked example of an OKF knowledge bundle that demonstrates the package pattern on the largest producer of agent-read markdown in the wild: a skill collection's reference layer. The OKF spec's
references/convention (§6.3) names this pattern in one line; this PR shows it at its most useful scale.Path convention: the upstream repo places recipes under
samples/<thing>/; this sample follows that pattern by including the pre-rendered bundle assamples/skill_reference_layer/bundle/. The recipe inREADME.mddocuments how the bundle was produced.What's in the bundle
21 typed concepts in 6 type groups, each carrying the OKF trust family:
Plus the bundle's navigational and decision surface:
index.md— progressive-disclosure listing, grouped by typelog.md— dated directory historydecisions.md(type: Decision Record) — six inline decision-record blocks (D-001..D-006)Conformance
Every concept file (except
index.mdandlog.mdper §8/§9 reserved-filename rules) carries parseable YAML frontmatter with non-emptytype. The trust family is two-event: aprocess:automated parse plus ahuman:review.sources[]resolves inside the bundle.Why this matters
The OKF v0.2 spec motivates its
references/convention in a single line. Skill collections are where that convention gets its hardest test: agent-written, agent-read, continuously maintained, load-bearing doctrine. This sample shows the cheapest upgrade: keep every path, add frontmatter + an index + a log, and the collection's reference layer becomes a traversable, trust-marked knowledge graph.Type taxonomy used in the bundle
The bundle uses six self-explanatory type values per OKF §4.1:
Skill(proposed for v0.3 — covered separately)Probe PromptModelTemplateDoctrinePlaybookindex.mdgroups the bundle by type.What's deliberately not in the sample
viz.html— knowledge-catalog's own tool generates those on accepted bundles; the contributor flow generates them post-acceptanceCompanion proposal
A separate issue argues for
type: Skillas a v0.3 conventional concept type — recommended frontmatter, recommended body sections, and trust-family defaults specific to skills. The bundle demonstrates the proposed shape; the proposal argues for adopting it into v0.3.What reviewers may focus on
index.mdgroupings are readable for someone landing in the bundle coldSmall edits reshape: the
Read Before You Writedoctrine is itself part of the bundle and is the cheapest discipline for review.