From d2b1f9d790f63115f1751c393b607d078ad2ceed Mon Sep 17 00:00:00 2001 From: Richard Abrich Date: Fri, 17 Jul 2026 17:46:33 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20banner=20=E2=80=94=20note=20the=20opena?= =?UTF-8?q?dapt-flow=20desktop=20record=20on-ramp=20role?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The status banner said this package is 'not the product' and 'the compiler does not require this package', which is accurate for the compiler core and the web path, but omitted the one documented product role capture DOES have: openadapt-flow's `record --backend windows|rdp` uses openadapt_capture.Recorder (via the optional `capture` extra) as its desktop demonstration recorder, and openadapt_flow.adapters.capture.convert_capture converts the session into the compile-ready recording format (openadapt-flow docs/desktop/RECORDING.md). Add one paragraph stating that role precisely so readers do not conclude the package is unused by the product. Co-Authored-By: Claude Fable 5 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1ce136d..0d734e0 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ > research direction, not the current product flow; the compiler does not > require this package. > +> This package does have one current product role: it is the **desktop +> demonstration recorder** behind `openadapt-flow record --backend windows|rdp`, +> installed via the optional `capture` extra +> (`pip install 'openadapt-flow[capture]'`). The operator's native +> mouse/keyboard/screen capture session is converted into the compiler's +> recording format by `openadapt_flow.adapters.capture.convert_capture` (see +> openadapt-flow's `docs/desktop/RECORDING.md`). The web recording path does not +> use this package. Requires `openadapt-capture >= 0.5.3` for headless-safe +> import. +> > The OpenAdapt product is the demonstration compiler, > [`openadapt-flow`](https://github.com/OpenAdaptAI/openadapt-flow), installed > via the [`OpenAdapt`](https://github.com/OpenAdaptAI/OpenAdapt) launcher