docs: note openadapt-flow desktop record on-ramp in status banner#27
Merged
Conversation
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 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The status banner added in #25 says this package is "not the product" and "the compiler does not require this package". Both statements are accurate — but the banner omits the one documented product role capture does have today:
openadapt-flow record --backend windows|rdpusesopenadapt_capture.Recorderas its desktop demonstration recorder, via the optionalcaptureextra (pip install 'openadapt-flow[capture]') — see openadapt-flowopenadapt_flow/desktop_record.pyanddocs/desktop/RECORDING.md.openadapt_flow.adapters.capture.convert_captureconverts the capture session into the compiler's recording format over capture's public API (CaptureSession.load(...).actions()), tested end-to-end in openadapt-flowtests/test_capture_adapter.py.Without this, a reader concludes the package is unused by the product and can be ignored/archived. This PR adds one paragraph to the banner stating the role precisely (including the
>= 0.5.3headless-import floor from #23/#24). No other content changes.Evidence
pyproject.toml:capture = ["openadapt-capture>=0.5.1"]__main__.py_cmd_record_desktop→desktop_record.record_desktop_capture→openadapt_capture.Recorder+convert_capturedocs/desktop/RECORDING.mddocuments this as the desktop recording path🤖 Generated with Claude Code