Skip to content

samples: add skill_reference_layer — a skill collection's reference layer as an OKF bundle - #313

Open
gamerey43 wants to merge 3 commits into
GoogleCloudPlatform:mainfrom
gamerey43:sample-skill-reference-layer
Open

samples: add skill_reference_layer — a skill collection's reference layer as an OKF bundle#313
gamerey43 wants to merge 3 commits into
GoogleCloudPlatform:mainfrom
gamerey43:sample-skill-reference-layer

Conversation

@gamerey43

Copy link
Copy Markdown

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 as samples/skill_reference_layer/bundle/. The recipe in README.md documents how the bundle was produced.

What's in the bundle

21 typed concepts in 6 type groups, each carrying the OKF trust family:

  • Skills (6) — entry-point routing + decision, search, connectivity-check, decide, bootstrap, publish concepts
  • Probes (4) — direction, adoption, threat, reversal job descriptions
  • Models (2) — three-moments, workflow-shapes
  • Templates (2) — decision-record-block, dispatch-contract
  • Doctrine (6) — read-before-you-write, provenance-is-first-class, errors-name-their-fix, state-has-a-curator, restate-then-investigate, cost-shaped-budget
  • Playbooks (1) — cold-start

Plus the bundle's navigational and decision surface:

  • index.md — progressive-disclosure listing, grouped by type
  • log.md — dated directory history
  • decisions.md (type: Decision Record) — six inline decision-record blocks (D-001..D-006)

Conformance

Every concept file (except index.md and log.md per §8/§9 reserved-filename rules) carries parseable YAML frontmatter with non-empty type. The trust family is two-event: a process: automated parse plus a human: 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 Prompt
  • Model
  • Template
  • Doctrine
  • Playbook

index.md groups the bundle by type.

What's deliberately not in the sample

  • No client-side knowledge domain content (the methodology is generic on purpose)
  • No real-world skill collection vocabulary (the names are fictional; the methodology is plausible but invented)
  • No viz.html — knowledge-catalog's own tool generates those on accepted bundles; the contributor flow generates them post-acceptance

Companion proposal

A separate issue argues for type: Skill as 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

  • Whether the type taxonomy (six values) is the right one
  • Whether the trust-family values (two-event verification) read as honest for a hand-authored bundle
  • Whether the index.md groupings are readable for someone landing in the bundle cold
  • Whether the deliberately generic methodology body of the bundle reads as a real corpus or as filler

Small edits reshape: the Read Before You Write doctrine is itself part of the bundle and is the cheapest discipline for review.

… 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.
@google-cla

google-cla Bot commented Aug 18, 2026

Copy link
Copy Markdown

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