Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ plus a validated repo seam are the default.
| `downstream.yml` | Registry of consumer repos for `bin/push-downstream`. |
| `seam-presets.yml` | Seam value adapter: org defaults + archetype presets. |
| `docs/` | Adoption, seam design, and operator guidance. |
| `CONTEXT.md` | Canonical glossary for batch coordination and lane lifecycle terms. |
| `examples/` | Example consumer-repo configuration snippets. |
| `test/fixtures/consumer-repo/` | Minimal fixture used by `bin/validate`. |

Expand Down Expand Up @@ -130,6 +131,10 @@ See [docs/adoption.md](docs/adoption.md) for the full adoption guide,
[docs/installation-and-upgrades.md](docs/installation-and-upgrades.md) for
ongoing host installs and upgrades.

Use [docs/source-pack-glossary.md](docs/source-pack-glossary.md) for canonical
vocabulary around source-pack distribution, install paths, seams, readiness
states, review findings, and state-machine fixtures.

## Downstream Seam Sync

`bin/push-downstream` rolls the binstub contract into the consumer repos listed
Expand Down
9 changes: 9 additions & 0 deletions docs/seam-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ environment, then make each consumer repo expose a small, validated contract:
- non-command policy is structured YAML in `.agents/agent-workflow.yml`
- `AGENTS.md` points humans and agents at those two sources

## Language

Use [source-pack-glossary.md](source-pack-glossary.md) as the canonical glossary
for terms such as Source Pack, Consumer Repo, Agent Workflow Configuration Seam,
Host Installer Path, Native Plugin Path, Workflow Lessons Library, Readiness
Vocabulary, Review Finding, and State-Machine Fixture. Keep this document
focused on the seam architecture; update the glossary when new workflow-pack
terms need stable meaning across issues, PRs, and implementation prompts.

## Architecture

```text
Expand Down
103 changes: 103 additions & 0 deletions docs/source-pack-glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Source Pack Glossary

Canonical vocabulary for distribution, seam, readiness, review, and
state-machine terms in this source pack. Keep batch coordination terms in the
root [CONTEXT.md](../CONTEXT.md).

## Language

**Source Pack**:
The shared `agent-workflows` repository that supplies portable skills,
workflows, helpers, and validation.
_Avoid_: plugin when referring to the whole repository before a native plugin
manifest is involved.

**Consumer Repo**:
A repository that uses the Source Pack while keeping its own policy in
`AGENTS.md`, `.agents/bin/`, and `.agents/agent-workflow.yml`.
_Avoid_: downstream when the important distinction is ownership of repo policy.

**Agent Workflow Configuration Seam**:
The `AGENTS.md` pointer section plus the Consumer Repo's repo-owned workflow
contract files.
_Avoid_: plugin settings, global config.

**Host Installer Path**:
The existing `bin/install-agent-workflows --host <host>` route that installs
skills, workflows, helper binaries, and metadata into a Codex or Claude home.
_Avoid_: legacy path.

**Native Plugin Path**:
A host-specific plugin manifest route, such as a Codex plugin manifest, that
exposes Source Pack skills through the host's plugin mechanism.
_Avoid_: universal plugin path.

**Workflow Lessons Library**:
A lightweight, curated `docs/solutions/` area for reusable Source Pack workflow
failure modes and fixes.
_Avoid_: full compounding system, session memory.

**Compound Engineering (CE)**:
The EveryInc `compound-engineering-plugin` source used as prior art for these
workflow improvement ideas.
_Avoid_: using CE as a synonym for this Source Pack or for every agent workflow.

**Readiness Vocabulary**:
The canonical human-facing state language for planning and batch handoffs, with
optional machine-readable blocks where automation needs them.
_Avoid_: mandatory JSON contract for every user-facing plan.

**Review Finding**:
A shared structured record for actionable or advisory review output across
review and audit skills.
_Avoid_: per-skill finding shapes with later ad hoc mapping.

**State-Machine Fixture**:
A deterministic test fixture that models a GitHub or git workflow state and its
expected transition.
_Avoid_: broad prose-only hardening.

## Relationships

- A **Source Pack** can be installed through a **Host Installer Path** or a
**Native Plugin Path**.
- A **Consumer Repo** owns exactly one canonical **Agent Workflow Configuration
Seam**.
- The **Native Plugin Path** must not replace the **Host Installer Path** for a
host unless it also covers that host's helper-binary and stale-skill-text
footguns.
- The **Workflow Lessons Library** captures portable Source Pack lessons, not
Consumer Repo domain policy.
- The **Readiness Vocabulary** must preserve explicit `UNKNOWN` states and must
not collapse them into ready or blocked.
- A **Review Finding** schema can be adopted incrementally, but the shape should
be shared from the first implementation.
- The first **State-Machine Fixture** target is `autoreview` target selection;
broader batch and current-head readiness fixtures come later.
- CE-derived improvements should be implemented in staged waves rather than one
Comment thread
justin808 marked this conversation as resolved.
parallel batch, because the **Workflow Lessons Library**, **Readiness
Vocabulary**, and **Review Finding** schema create downstream vocabulary.

## Example Dialogue

> **Dev:** "Can we add a Codex plugin manifest and tell Claude users to use it?"
> **Maintainer:** "No. The Codex **Native Plugin Path** is v0 Codex-only.
> Claude users stay on the **Host Installer Path** until the Claude path has no
> helper-binary or stale-skill-text footguns."

## Flagged Ambiguities

- "plugin" can mean the Codex-native manifest surface or the entire Source
Pack. Resolved: use **Native Plugin Path** for host plugin manifests and
**Source Pack** for the repository as a whole.
- `docs/solutions/` could mean a full Compound Engineering-style compounding
workflow or a small curated library. Resolved for v0: use **Workflow Lessons
Library** for the lightweight curated form.
- "machine-readable readiness contract" could mean mandatory JSON in every
planning output. Resolved for v0: define a **Readiness Vocabulary** first and
keep structured blocks optional unless a workflow explicitly needs automation.
- "structured review output" could mean each skill emits its own JSON shape.
Resolved for v0: define one shared **Review Finding** schema and adopt it in
one review path first.
- "state-machine hardening" could target the whole batch workflow at once.
Resolved for v0: start with `autoreview` target selection fixtures.
Loading