@fern-api/replay 0.15.0 → 0.15.2

package/README.md

@@ -4,15 +4,27 @@ Automatically preserves SDK customizations across Fern regenerations.
 
 ## What it does
 
-Fern Replay detects user edits to generated SDK code, stores them as patches, and re-applies them after each regeneration using 3-way merge. This means your customizations survive `fern generate` without manual intervention.
+Fern Replay detects your edits to generated SDK code, stores them as patches in `.fern/replay.lock`, and re-applies them after each regeneration using 3-way merge. Your customizations survive `fern generate` without manual intervention.
 
-## Pipeline
+## The replay loop
 
-1. **Detect** — Find commits since last generation
-2. **Store** — Save patches to `replay.lock`
-3. **Generate** — Run generator (overwrites all)
-4. **Replay** — Apply patches via 3-way merge
-5. **Commit** — Commit the merged result (or surface conflicts)
+Three phases. The generator runs between **detect** and **apply**, overwriting everything in the SDK directory.
+
+1. **Detect** — find new customizations in the customer's git history since the last generation
+2. **Apply** — put them back onto the freshly generated code via 3-way merge
+3. **Commit** — record the result as a `[fern-replay]` commit on top of the `[fern-generated]` one
+
+## Vocabulary
+
+The team's canonical vocabulary — *customization*, *patch*, *generation*, the three merge sides, the patch lifecycle verbs — lives in [`CONTEXT.md`](./CONTEXT.md).
+
+## Documentation
+
+- [`CONTEXT.md`](./CONTEXT.md) — domain language and team voice
+- [`docs/architecture.md`](./docs/architecture.md) — module structure, design decisions, integration with `fern/fern`
+- [`docs/reference.md`](./docs/reference.md) — types, customer flows, CLI commands, key algorithms
+- [`docs/known-divergences.md`](./docs/known-divergences.md) — places where multiple implementations exist intentionally
+- [`docs/migration-guide.md`](./docs/migration-guide.md) — upgrade and migration notes
 
 ## Install