Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Starter example — a complete mini-KB

A small, navigable, end-to-end instance of the methodology for a single document. Everything here is synthetic and fictional (the "FCS-12 field cable tensioning standard" does not exist) — it exists only to show the three layers working together. No real-world content.

What's here, mapped to the three layers

starter-example/
├── sources/
│   └── fcs-12-cable-tensioning.md          # L3 — verbatim source of truth + frontmatter
├── skills/
│   └── fcs-12-cable-tensioning/            # L2 — Book-to-Skill bundle (navigable)
│       ├── SKILL.md                        #      master: framework + topic index (load this first)
│       ├── chapters/
│       │   ├── ch01-tensioning-limits.md   #      loaded on demand
│       │   └── ch02-inspection.md
│       ├── glossary.md
│       ├── cheatsheet.md
│       └── patterns.md
└── wiki/
    └── syntheses/
        └── fcs-12-reliability.md           # governance — claims about the source's reliability

Layer 1 (the DB + typed tools) isn't reproduced as data here — see templates/mcp-tools/ for its shape. In a real deployment, a row in documents would point source_path at the file in sources/ and skill_path at skills/fcs-12-cable-tensioning/SKILL.md.

How an agent would traverse it

  1. Discover via Layer 1: search("cable tensioning limits") → a Hit whose skill_path points to the SKILL.md.
  2. Navigate via Layer 2: open SKILL.md; its topic index routes "limits" → ch01. Deterministic, every time.
  3. Cite via Layer 3: when quoting, go to sources/fcs-12-cable-tensioning.md.
  4. Govern: wiki/syntheses/fcs-12-reliability.md tracks what's verified vs. not — note the unverified claim that a low-confidence dashboard would surface.

Compare each file with its skeleton in templates/ to see the convention applied.

Note on links inside the bundle. Cross-references within the skill (e.g. SKILL.md/sources/…, patterns.md/wiki/…) use absolute, bundle-root-relative paths — the convention this methodology recommends for stability (see methodology/01). Here the bundle root is starter-example/. An OKF-aware agent resolves them; GitHub's web file viewer treats / as the repo root, so those particular links won't be clickable in the browser. This README and the layer-mapping above use ordinary relative links, which are clickable.