From 6b2a37028f16dcc6e7e69cbc78fef64b252190ee Mon Sep 17 00:00:00 2001 From: homen Date: Thu, 15 Oct 2026 06:57:01 -0700 Subject: [PATCH] docs: clarify the default clip example and reviewed handoff --- README.md | 13 +++++++++---- promotion/PROMOTION_LOG.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0470ce0..dc5c016 100644 --- a/README.md +++ b/README.md @@ -269,6 +269,11 @@ so `npm run clip` means the same thing in all three. ## Quick start +For the [reviewed local LiveSync example](HANDOFF.md#first-render), use +`WTC-LiveSync` and the locked setup in that handoff. It renders retained local, +in-memory captures without an app or model call; the default example below has +a separate output-quality hold. + **Prerequisites:** Node 18+, `ffmpeg` on PATH, and your app running locally in a clean (no‑auth / demo) state. @@ -290,10 +295,10 @@ npm run render:example # -> out/example.mp4 ffmpeg -y -i out/example.mp4 -vf "fps=15,scale=720:-1:flags=lanczos,split[s0][s1];[s0]palettegen=max_colors=128:stats_mode=diff[p];[s1][p]paletteuse=dither=bayer:bayer_scale=3:diff_mode=rectangle" -loop 0 example.gif ``` -The bundled example is a [solo-founder 3D proof-run app](https://github.com/HomenShum/solo-founder-agent-builder) -(builder console → generate a scroll-driven 3D product story → customer-facing landing -page → internal proof report with gates) — the captured frames + -`src/walkthrough.data.js` are included so it renders immediately. +`npm run render:example` selects `WT-NodeRoom`, the historical +[NodeRoom](https://github.com/HomenShum/NodeRoom) single-pane walkthrough. +Its captured frames and `src/walkthrough.data.js` are included; rendering them +does not recapture NodeRoom or establish current application behavior. ## Make it your own diff --git a/promotion/PROMOTION_LOG.md b/promotion/PROMOTION_LOG.md index 6bb052f..aadd7bc 100644 --- a/promotion/PROMOTION_LOG.md +++ b/promotion/PROMOTION_LOG.md @@ -653,3 +653,31 @@ report can be honest in every claim and still carry numbers from the wrong run. them — condition 5's error state is proved on the add path, which is the one a user hits — but an unexercised branch is an unexercised branch, and it is written down rather than left for the next reader to discover. + + +## Documentation correction - 2026-10-15 + +A developer trying the first render needs the README to name the example its +command actually selects. The Quick start called it a Solo Founder 3D app, +while the unchanged package script selects the historical `WT-NodeRoom` +single-pane composition. + +- **Changed:** `README.md` now names that NodeRoom example and links the separately + reviewed local `WTC-LiveSync` route in [the handoff](../HANDOFF.md#first-render) + before the default commands. Rendering retained captures is distinct from + recapturing an application or proving its current behavior. The default's + separate output-quality hold remains explicit. +- **Before/after:** the same finite source/command/link check found two mismatches + before the edit and zero afterward (8/10 to 10/10). It checks example identity, + the existing handoff anchor/composition route, every unchanged fenced block, + generated branding and the unchanged source/config boundary. This is a + documentation check, not a render, product-quality score or fresh media proof. +- **Validation:** the existing `node check.mjs` exited 0 before and after the + README correction: 48/48 JavaScript parses, 36/36 tour anchors, 34/34 prose + citations and three retained render-record byte bindings. The output was + identical. The existing command excludes this promotion log; this entry is + appended after those checks, with its original raw-byte prefix preserved. +- **Conditions newly PASS:** none. No command, runtime, configuration, dependency, + image or video changed. No capture, render, browser, provider, deployment or + new release-readiness observation was performed. Earlier failures and grades + above remain historical, with their original evidence boundaries.