From 5acba397f9fbe3a325481035c1de51d12df2c9b9 Mon Sep 17 00:00:00 2001 From: Nahiyan Khan Date: Fri, 12 Jun 2026 17:16:00 -0400 Subject: [PATCH] Update Relay generation docs --- .changeset/bright-relay-docs.md | 5 +++++ docs/fingerprint-format.md | 4 ++-- docs/generation-loop.md | 6 +++++- docs/host-adapters.md | 4 +++- docs/ideas/fingerprint-first-architecture.md | 4 ++-- 5 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 .changeset/bright-relay-docs.md diff --git a/.changeset/bright-relay-docs.md b/.changeset/bright-relay-docs.md new file mode 100644 index 00000000..87bc7211 --- /dev/null +++ b/.changeset/bright-relay-docs.md @@ -0,0 +1,5 @@ +--- +"@anarchitecture/ghost": patch +--- + +Update documentation to point generation-context workflows at `ghost relay gather`. diff --git a/docs/fingerprint-format.md b/docs/fingerprint-format.md index bae9e9cf..eaeb27cb 100644 --- a/docs/fingerprint-format.md +++ b/docs/fingerprint-format.md @@ -38,7 +38,7 @@ id: local The raw layer files can be sparse. Missing files or sections normalize to empty layers when Ghost assembles the internal `ghost.fingerprint/v1` document used -by checks, review packets, context bundles, compare, and stack merges. +by checks, review packets, Relay briefs, compare, and stack merges. ## Core Layers @@ -251,7 +251,7 @@ ghost verify .ghost --root . ghost check --base main --format json ghost review --base main --include-memory ghost emit review-command --path apps/checkout/review/page.tsx -ghost emit context-bundle +ghost relay gather apps/checkout/review/page.tsx ``` `ghost scan` reports readiness in the same three-layer vocabulary. Useful diff --git a/docs/generation-loop.md b/docs/generation-loop.md index d6942488..44046dc8 100644 --- a/docs/generation-loop.md +++ b/docs/generation-loop.md @@ -22,7 +22,11 @@ deterministic gates + advisory surface-composition findings ## Before Generation -Build a brief from the generation packet: +Build a brief from the resolved fingerprint stack: + +```bash +ghost relay gather apps/checkout/review/page.tsx +``` 1. Read `.ghost/fingerprint/prose.yml`, `.ghost/fingerprint/inventory.yml`, and `.ghost/fingerprint/composition.yml`. diff --git a/docs/host-adapters.md b/docs/host-adapters.md index c1676739..cdf6ed87 100644 --- a/docs/host-adapters.md +++ b/docs/host-adapters.md @@ -18,7 +18,8 @@ Ghost provides: - `ghost check --format json` as the stable `ghost.check-report/v1` contract. - `ghost review --format json` for advisory packets grounded in the resolved fingerprint stack. -- `ghost emit context-bundle` for a split generation packet. +- `ghost relay gather [target] --format json` as the `ghost.relay.gather/v1` + contract for generation context. - `--memory-dir ` for wrappers that store Ghost package roots somewhere other than `.ghost`. @@ -62,6 +63,7 @@ at `fingerprint/`. Wrappers can use any safe relative package root: ```bash ghost init --scope apps/checkout --memory-dir .design/memory ghost stack apps/checkout/review/page.tsx --memory-dir .design/memory --format json +ghost relay gather apps/checkout/review/page.tsx --memory-dir .design/memory --format json ghost check --base main --memory-dir .design/memory --format json ghost review --base main --memory-dir .design/memory --format json ``` diff --git a/docs/ideas/fingerprint-first-architecture.md b/docs/ideas/fingerprint-first-architecture.md index b1dd86e5..0e04f54f 100644 --- a/docs/ideas/fingerprint-first-architecture.md +++ b/docs/ideas/fingerprint-first-architecture.md @@ -51,7 +51,7 @@ and flow. That makes the fingerprint more like an upstream contract than a static guideline or a downstream inspection report. Review, linting, comparison, -generation packets, authoring tools, marketing workflows, and vibe-coding +Relay briefs, authoring tools, marketing workflows, and vibe-coding workflows can all use the same checked-in surface context. Their outputs differ, but their source of truth is the fingerprint. @@ -69,7 +69,7 @@ fingerprint lifecycle: | --- | --- | --- | | Capture | `init`, `inventory`, `scan` | Create the package, gather optional source material, and report layer readiness. | | Validate | `lint`, `verify` | Check schema shape, refs, evidence, exemplars, and deterministic package quality. | -| Generate / apply | `emit context-bundle`, host agents, future generation consumers | Give agents the upstream surface-composition contract before they build or revise. | +| Generate / apply | `relay gather`, host agents, future generation consumers | Give agents the upstream surface-composition contract before they build or revise. | | Govern | `check`, `review`, `ack`, `track`, `diverge` | Validate changed surfaces, produce advisory findings, and record stance toward divergence. | | Compare | `compare`, fleet-style analysis | Understand distance, cohorts, reference relationships, and change across packages. |