Skip to content

docs: stop describing shipped work as future - #1

Merged
ArtRiv merged 1 commit into
mainfrom
docs/readme-actual-state
Sep 5, 2026
Merged

ArtRiv merged 1 commit into
mainfrom
docs/readme-actual-state

Conversation

@ArtRiv

@ArtRiv ArtRiv commented Sep 2, 2026

Copy link
Copy Markdown
Owner

transcribe_engine/webrtc/, transcribe_engine/pairing/ and transcribe_engine/signaling/ are all on main, with the phase-8 commits that built them. The README still says:

The engine pairs with the hosted webapp over WebRTC in a future release

and marks two rows of the privacy table "(Phase 8+)".

What changed

  • Status separates the two states honestly, which the old text collapsed: v0.1.1 is the latest published release, and pairing plus the WebRTC transport are implemented on main but not in the published binaries yet. I checked git ls-tree v0.1.1 — the tag has neither webrtc/ nor pairing/ — so "already shipped" would have been just as wrong as "future release".
  • Privacy table and architecture notes drop the "(Phase 8+)" qualifiers, since that code is present.
  • "Install (v0.1.0)" → "Install". The link under the heading already points at /releases/latest, and the heading was a release behind. Leaving the version out of the heading keeps it from going stale again.

pyproject.toml still declares 0.1.0, so the "Expect: transcribe-engine 0.1.0" line in the source-build smoke test is left as is — it's correct for a build from main.

`webrtc/`, `pairing/` and `signaling/` are on main, but the README still
said pairing lands "in a future release" and marked half the privacy
table "(Phase 8+)".

- Status separates the two honestly: v0.1.1 is the latest published
  release, and pairing plus the WebRTC transport are implemented on main
  but are not in the published binaries yet.
- The privacy table and the architecture notes drop the "(Phase 8+)"
  qualifiers, since that code is present.
- "Install (v0.1.0)" becomes "Install": the link under it already points
  at /releases/latest, and the heading was already a release behind.
@ArtRiv
ArtRiv merged commit 2066b7a into main Sep 5, 2026
1 of 2 checks passed
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