Meta Agent Tools
PT

Back to the catalog

Open Knowledge Format Index

Bundle OKF 0.1 · 4 conceitos · pnw/trellis

Open source Repository Open in the app JSON README (API)

About

# Open Knowledge Format Index

## Overview

- [Open Knowledge Format](overview.md) — Purpose, scope, navigation, and current understanding for knowledge about Open Knowledge Format and its document conventions.

## Source Captures

- [Legacy Pointer Stub: Open Knowledge Format v0.1 Specification](sources/open-knowledge-format-spec.md) — A legacy pointer stub for the Open Knowledge Format specification, without the specification body.

## Entities

- [Open Knowledge Format (OKF)](entities/open-knowledge-format.md) — A provisional description of Google's Open Knowledge Format based on external specification links; the locally retained raw artifact is only a pointer stub.
- [YAML Frontmatter](entities/yaml-frontmatter.md) — A metadata convention placing a YAML block between triple-dashed lines at the top of a markdown file. Popularized by Jekyll (2008), now ubiquitous in static site generators, knowledge bases, and agent-readable formats like OKF.

Details

Kind
OKF bundles
Topic
AI, RAG & memory
Publisher
pnw
Origin
okf_github
Category
dados
Version
0.1
Last push
2026-07-31T06:58:40Z
Repository state
ativo
Language
Python
Added
2026-09-08 16:05:40
Updated
2026-09-08 16:05:40
Origin id
pnw/trellis:workspace/wiki/open-knowledge-format/index.md

README

# Trellis

Trellis is a descriptive language for expressing work artifacts, not a system
for controlling how work advances. It defines typed, human- and agent-readable
Markdown artifacts that capture knowledge, intended outcomes, and the context
needed to understand them.

Trellis contracts describe declarative artifact states and minimum information
requirements. They do not, merely by defining a type, maturity, status,
directory, link, checkbox, question, or follow-up, prescribe approval,
assignment, priority, authorization, or a workflow transition. A workflow or
agent may use Trellis artifacts as inputs and completion criteria without
Trellis dictating how that workflow operates.

The copyable [`trellis/`](trellis/) directory is the minimum implementation. It
contains a concise [operating manual](trellis/OPERATING.md), an
[agent-instructions example](trellis/AGENTS.example.md), and two independent,
agent- and human-readable contracts:

- [Knowledge Topic](trellis/knowledge-topic.md) — a typed,
  provenance-preserving knowledge bundle conforming to Open Knowledge Format
  (OKF).
- [Trellis Design](trellis/design.md) — a dossier whose `design.md` is a
  complete architectural handoff and whose supporting documents are required
  when their triggering concerns exist.

Each specification is a standalone document. An agent can create a conforming
artifact from the raw URL without cloning this repository or installing tools.

The specifications are independently versioned drafts. Released versions use
immutable-by-policy tags:

```text
https://raw.githubusercontent.com/pnw/trellis/knowledge-topic-v0.1.0/trellis/knowledge-topic.md
https://raw.githubusercontent.com/pnw/trellis/design-v0.2.0/trellis/design.md
```

Until those tags are released, use the files in this repository rather than
assuming the example tag URLs exist.

## Repository Layout

```text
trellis/
  OPERATING.md                  # Portable operator manual
  AGENTS.example.md             # Context-efficient agent routing example
  knowledge-topic.md            # Normative Knowledge Topic contract
  design.md                     # Normative Design contract
kit/
  skills/                       # Optional agent workflows
  templates/                    # Optional scaffold files
  adapters/                     # Optional tool-specific loading wrappers
  scripts/                      # Optional validators and helpers
workspace/
  wiki/                         # Non-normative Knowledge Topic collection
  designs/                      # Non-normative Design collection
```

Only `trellis/knowledge-topic.md` and `trellis/design.md` are normative.
`trellis/OPERATING.md`, `trellis/AGENTS.example.md`, the
[optional kit](kit/README.md), and the dogfood Workspace apply or explain the
contracts but do not define conformance.

The Workspace is only a directory convention. It has no manifest, schema,
catalog, router, registry, or validator. A Wiki is the collection under
`workspace/wiki/`; each child Knowledge Topic is the conforming unit. The
existing root `designs/` directory remains legacy lab content excluded from the
0.1 framework.

## Use

To create a Knowledge Topic, give an agent the raw specification and one
governing purpose:

> Read this specification and create a Knowledge Topic for this subject:
> `<versioned raw Knowledge Topic URL>`

To create a design:

> Read this specification and create a Trellis Design for this change:
> `<versioned raw design URL>`

For the local, Markdown-only core, copy `trellis/` into the target repository
and adapt `trellis/AGENTS.example.md` into the instruction file recognized by
the target agent. For scaffolding, ingest, query, lint, or design-authoring
accelerators, install only the relevant components from `kit/`.

## Versioning

Knowledge Topic and Design evolve independently with semantic versions:

- `knowledge-topic-v<major>.<minor>.<patch>`
- `design-v<major>.<minor>.<patch>`

Release tags are never moved or deleted. A patch clarifies without changing
conformance. While a contract remains an unreleased `0.x` draft, a breaking
revision increments the minor version; each contract defines its post-1.0
minor and major semantics.

More