Skip to content

docs: correct stale Capture recorder facts and mark the extension a prototype - #76

Merged
abrichr merged 1 commit into
mainfrom
codex/promote-capture-beta
Aug 20, 2026
Merged

docs: correct stale Capture recorder facts and mark the extension a prototype#76
abrichr merged 1 commit into
mainfrom
codex/promote-capture-beta

Conversation

@abrichr

@abrichr abrichr commented Aug 18, 2026

Copy link
Copy Markdown
Member

What changed

This pull request now carries documentation and metadata corrections only.
The lifecycle relabel that it originally contained is held back.

  • correct the transcription extra: [audio] does not exist, [transcribe-fast] does
  • correct video.py: it drives an external FFmpeg process and does not use PyAV
  • correct the slow-test description: the recording pipeline uses native input observers, not pynput
  • correct the privacy claim: privacy is an optional integration, not automatic scrubbing
  • correct the recording-path table: native capture covers Windows, macOS, and Linux, and window-scoped capture covers an RDP or Citrix client window
  • correct the browser row and link the openadapt-flow browser recording guide, which now exists on Flow main after Flow #364
  • correct stale Flow adapter limits: the adapter compiles right clicks, left-button drags, modifier chords, and scrolling
  • mark the Chrome extension, its bridge transport, and its event schemas as a development prototype, and record its promotion contract
  • mark docs/DESIGN.md and docs/VISUALIZATION_DESIGN.md as historical where they no longer describe the current API

What was held back

The founder's rule is that Capture moves from Experimental to Production in
one visible change, at the end, once its qualification evidence exists.
There is no interim Beta step. These hunks stay unmerged:

File Held hunk
README.md **Status: Experimental.** -> **Status: Beta.**
pyproject.toml Development Status :: 2 - Pre-Alpha -> Development Status :: 4 - Beta
pyproject.toml package description rewrite (release metadata must move with the single visible change)
CLAUDE.md "is the Beta canonical native recorder"
chrome_extension/README.md "The package is the Beta canonical native recorder."
docs/DESIGN.md "The current Beta recorder writes ..."

The original head c937787c4e32b81f7f9ade282b4e81a0719317c9, which contains
all of those hunks, is preserved on branch codex/promote-capture-beta-original.

The .github/workflows/test.yml hunk is also dropped. PR #81 already landed a
stronger bounded apt install on main, so main's version is kept.

Validation

  • 387 tests passed, 1 skipped, 8 deselected
  • Ruff passed
  • wheel and source archive built, both passed scripts/verify_distribution.py
  • source-boundary check passed for the tree, wheel, and source archive

🤖 Generated with Claude Code

Correct documentation facts that no longer describe the shipped package,
and separate the Chrome extension prototype from the supported paths.

- CLAUDE.md: the `[audio]` extra does not exist; the transcription extra is
  `transcribe-fast`. `video.py` drives an external FFmpeg process and does
  not use PyAV. The recording pipeline uses native input observers, not
  pynput. Privacy is an optional integration, not automatic scrubbing.
- README.md: native capture covers Windows, macOS, and Linux, and
  window-scoped capture covers an RDP or Citrix client window. Flow's
  Playwright recorder can now launch Chromium or attach to one existing
  signed-in local Chromium tab, and its browser recording guide exists, so
  link it. The Flow adapter compiles right clicks, left-button drags,
  modifier chords, and scrolling; the old limitation text was wrong.
- Mark the Chrome extension, its bridge transport, and its event schemas as
  a development prototype, and record the promotion contract it must meet.
- Mark docs/DESIGN.md and docs/VISUALIZATION_DESIGN.md as historical where
  they no longer describe the current API.

This change carries no lifecycle label movement. The package stays
Experimental in README.md and stays `Development Status :: 2 - Pre-Alpha`
in pyproject.toml. Capture moves from Experimental to Production in one
later visible change, once its qualification evidence exists.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@abrichr
abrichr force-pushed the codex/promote-capture-beta branch from c937787 to 0848cf9 Compare August 20, 2026 01:16
@abrichr abrichr changed the title docs: publish Capture as the canonical native recorder docs: correct stale Capture recorder facts and mark the extension a prototype Aug 20, 2026
@abrichr
abrichr marked this pull request as ready for review August 20, 2026 01:19
@abrichr
abrichr merged commit 0799088 into main Aug 20, 2026
12 checks passed
@abrichr
abrichr deleted the codex/promote-capture-beta branch August 20, 2026 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant