Skip to content

Commit 84431de

Browse files
authored
Merge pull request #28 from idsinge/docs/phase6-execution-records
docs: record Phase 6 execution model (verification in latency-test-examples)
2 parents b261e3a + 1f81233 commit 84431de

3 files changed

Lines changed: 13 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Phases 1–3b are complete. The `<latency-test>` Custom Element is implemented w
241241
- `worker.js` cross-correlates two buffers: in the audioworklet path these are `{ mic, ref }` Float32 PCM; in the mediarecorder (2ch) path these are `ch0` (mic) and `ch1` (reference) from the decoded stereo recording; in the mediarecorder-1ch path these are the decoded mono recording vs the pre-generated MLS AudioBuffer
242242

243243
**Still in progress:**
244-
- Phase 6: framework example end-to-end verification against the published `@adasp/latency-test@1.2.0` package — the only remaining v1 item. (Phase 4 is complete: browser verification matrix done across all three modes; host-side histogram moved to the Phase 8 experimentation toolkit.)
244+
- Phase 6: framework example end-to-end verification against the published `@adasp/latency-test@1.2.0` package — the only remaining v1 item. Verification host apps live in the dedicated repo https://github.com/idsinge/latency-test-examples (published-package-only; methodology in that repo's CLAUDE.md). (Phase 4 is complete: browser verification matrix done across all three modes; host-side histogram moved to the Phase 8 experimentation toolkit.)
245245

246246
**Planned configurable attributes (beyond `number-of-tests`, `mls-bits`, `max-lag-ms`):**
247247

agents/KNOWN_ISSUES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Each entry records the source, severity, current status, and what would be neede
1212
**Source:** `agents/CLAUDE_REVIEW.md` Phase 6 gate · **Severity:** Low
1313
**Detail:** The six framework example pages (`docs/examples/*.md`: vanilla-js, React, Vue, Svelte, Angular, Next.js) were updated based on the local source but have not been verified end-to-end against the actual installed npm package. (The seventh page, `host-gain.md`, is a pattern page outside this gate — it is exercised by the demo's Host Gain panel against the built bundle.) Draft notices were removed trusting the code to be correct — if an example has a subtle error it would only surface during a consumer's actual use.
1414
**Fix:** For each framework: install `@adasp/latency-test` in a fresh project, follow the example page instructions exactly, confirm the component registers and emits events correctly. Only then is the example considered fully verified.
15+
**Status (2026-06-12):** verification prepared, not yet started — execution model recorded; the dedicated examples repo https://github.com/idsinge/latency-test-examples is seeded (methodology in that repo's `CLAUDE.md`; execution model in `agents/SESSION_HANDOFF.md`). All matrix rows pending.
1516

1617
---
1718

agents/SESSION_HANDOFF.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ See `agents/KNOWN_ISSUES.md` for open findings from code reviews (Codex, DeepSee
1010

1111
## Current Repo State
1212

13-
- Stable base: `main` (branch protection: PR + "ci" status check required — work on a branch and open a PR). Current working branch: `docs/install-dedup-build-output` (PR #25 — docs cleanup, histogram move to Phase 8, and Codex consistency fixes; merge pending CI). `webcomponent` fully merged via PRs #14–24.
13+
- Stable base: `main` (branch protection: PR + "ci" status check required — work on a branch and open a PR). All cleanup PRs merged: #25 (histogram→Phase 8 + consistency fixes), #26 (install.md demo instructions, stale-text cleanup, review-prompt.md deleted), #27 (AGENTS.md fixes stranded by a merge race). No active working branch — Phase 6 verification runs in the external examples repo (see "Phase 6 execution model" below). `webcomponent` fully merged via PRs #14–24.
1414
- Phases 1–7 complete. **v1.2.0** is live on npm as `@adasp/latency-test` (released 2026-06-12).
1515
- `dist/` remains gitignored — generated with `npm run build:component`.
1616
- `demo/` validates the built IIFE bundle via `../dist/latency-test.legacy.iife.js`. Run with `npm run build:component:legacy && npm run demo`.
@@ -117,6 +117,16 @@ See `agents/KNOWN_ISSUES.md` for open findings from code reviews (Codex, DeepSee
117117
### Phase 6 remainder
118118
- [ ] Framework example end-to-end verification — before treating any framework example as verified, test it against the installed published package `@adasp/latency-test@1.2.0` (not local source). Scope: the six framework pages (vanilla-js, React, Vue, Svelte, Angular, Next.js). `host-gain.md` is out of scope — it is a pattern page exercised by the demo's Host Gain panel against the built bundle (decision 2026-06-12). All Draft labels are already removed; if examples are found wrong during verification, a patch is needed.
119119

120+
#### Phase 6 execution model (2026-06-12)
121+
122+
Verification happens in a dedicated external repo: **https://github.com/idsinge/latency-test-examples** (local: `~/Desktop/latency-test-examples`). Rationale: structurally guarantees published-package consumption (no `file:`/workspace links possible), keeps this research repo lean, isolates dependency noise. That repo's `CLAUDE.md` is the single source of truth for the verification methodology — do not duplicate its rules here. Key facts only:
123+
124+
- Two tiers: `examples/` = the six framework apps (this Phase 6 gate; exact pin `1.2.0`, apps mirror the docs pages literally, README matrix with per-check legend = the verification record incl. docs-commit SHA and environment); `demos/` = latency-compensation R&D (waveform-playlist React, `@dawcore/*`), **hard-quarantined until Tier 1 signoff**.
125+
- Pass criteria were tightened through two Codex review rounds — five success-path events + no `latency-error`, deliberate negative-path test, registry-consumption proof, dev AND production build with clean console, CDN variant for vanilla-js, environment recorded.
126+
- A separate Claude instance works there, bootstrapped by `agents/KICKOFF_PROMPT.md` in that repo. Status at handoff: seed files review-hardened (two Codex rounds) and committed (examples repo initial commit `0804b8f`); verification work itself not yet started — all matrix rows pending.
127+
- Forced deviations from a docs page are findings → relayed back to THIS repo as docs patches (branch + PR, as usual).
128+
- **Phase 6 signoff happens here** when the matrix is complete: run `npm run build:component:all`, `npm run docs:build`, `npm pack --dry-run`; close the KNOWN_ISSUES open item; update this file; link the verified examples repo from the docs.
129+
120130
### Independent
121131
- [x] **CI Node version divergence** — Intentional and closed. `.nvmrc=22` (local dev), `ci.yml=20` (test/build job), `docs.yml=24` (Pages build/deploy workflow). All satisfy `engines: >=18`. See `agents/KNOWN_ISSUES.md`.
122132

0 commit comments

Comments
 (0)