chore: open-source readiness pass - #2
Merged
Conversation
Prepare live-streamer for public release. Deleted internal/dev-only docs: REPORT.md, CHANGELOG.md, PHASE_3_DESIGN.md (internal kill-test session IDs), the docs/superpowers/plans/ design-history set, docs/notes/, docs/plans/, four loose spec docs, and an internal HeyGen backend bug report. Scrubbed internal references: removed the "canary" internal staging-env name from all code comments and docs (neutralized to "the HeyGen API"/"HeyGen"), genericized live test-session IDs and example avatar/voice IDs, and softened the "internal monorepo extraction" framing. Removed dangling links to deleted docs (STATUS.md, CHANGELOG.md, PLAN.md, PHASE_3_DESIGN.md, word-end-backlog- gate-spec.md) from README, TECHNICAL_OVERVIEW, and code comments. Scrubbed the M1 ARCHITECTURE doc (awaiting-signoff framing, internal backend source citations, ai-twitch-streamer references). Added: MIT LICENSE, CONTRIBUTING.md, and a rewritten README with system + roast-lifecycle Mermaid diagrams, prerequisites, setup, and run instructions. Code hygiene: the packages were already clean (no debug prints beyond the intentional notify.py fallback, no TODO/XXX/HACK, no commented-out code, no placeholder tests), so no logic changed — comment scrubs only. — Ralu 🦦
raluagent-ai
force-pushed
the
chore/oss-readiness-pass
branch
from
July 11, 2026 00:23
9187ee5 to
2d6105f
Compare
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
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.
Open-source readiness pass for a public release of
live-streamer. No runtime behavior changes — deletions, content scrubs, doc additions, and comment-only edits.Deleted (internal / dev-only docs)
REPORT.md,CHANGELOG.md(687-line internal engineering log)stream_orchestrator/PHASE_3_DESIGN.md— internal design doc containing live kill-test session IDsresearch/HEYGEN_REALTIME_STALL_20260602.md— internal HeyGen backend bug reportdocs/launch-fixes-spec.md,docs/prompt-restructure-spec.md,docs/word-end-backlog-gate-spec.mddocs/notes/(3),docs/plans/(1), anddocs/superpowers/plans/(9) — empty dirs removeddocs/superpowers/specs/2026-05-27-episode-v2-design-and-plan.md— a not-explicitly-listed doc I judged internal (authored "Claude (no mentor)", addressed to "a new Claude session with no memory")Scrubbed (kept the file, fixed the content)
canary(HeyGen internal staging-env name) removed from all code comments and docs — neutralized to "the HeyGen API" / "HeyGen" / "staging" as fit context. Coversstream_orchestrator/*(client/poller/supervisor/http_server/main/config.toml),ARCHITECTURE.md,RUN.md,TECHNICAL_OVERVIEW.md,showrunner/*,script_producer/producer_config.toml, the demo HTML. (One remaining "canary" intest_activity_state.pyis the coal-mine sense — a canary test — left intact.)auto-40122cf8-0005inruntime.py; exampleavatar_id/voice_idinRUN.md→<your-...>placeholders.STATUS.md,CHANGELOG.md,PLAN.md(none exist) from README/TECHNICAL_OVERVIEW; andPHASE_3_DESIGN.md/word-end-backlog-gate-spec.mdpointers stripped from code comments now that those docs are gone.TECHNICAL_OVERVIEWto neutral standalone-project wording.stream_orchestrator/ARCHITECTURE.md: removed "draft — awaiting signoff / do not start implementation" scratch framing, the "Open questions for user signoff / before I start Phase 1" framing,ai-twitch-streamer/references, and internal HeyGen backend source line-citations (controller :37-61,service :563-656,emitter :1001, …) → generic "HeyGen API".Added
LICENSE— MIT,Copyright (c) 2026 HeyGenCONTRIBUTING.md— per-packageuvsetup, Python 3.11, how to run tests, PR expectationsclaude-opus-4-8, reactive plannerclaude-sonnet-4-6, chat ackclaude-haiku-4-5), the M1↔HeyGen↔OBS↔Twitch flow, ports, and scripts.Code hygiene
Conservative pass across the 4 packages. The code was already clean: the only
print()in package source is the intentionalnotify.pystderr fallback (kept); noTODO/XXX/HACK/FIXME; no commented-out code blocks; nopdb/breakpoint; no placeholder/no-op tests. No logic changed — the only source edits are comment scrubs. All edited Python files passpy_compile.Flagged for your call
uvisn't available in my environment, so I could not executepytest. No logic changed, so risk is low, but please confirm CI is green. (For reference,def test_counts: stream_orchestrator 217 · showrunner 1248 incl. 7 live · chat_ingester 111 · script_producer 53.)MODULE_2_ARCHITECTURE.mdreferences (~20, instream_orchestrator/*andscript_producer/*comments +MODULE_1_BRIEF.md,MODULE_2_BRIEF.md): these docs were dropped in the original extraction, before this PR. I left them untouched (out of scope, and mass comment-editing is risky) — flagging so you can decide whether to strip them.Nacos+ internal backend file citations in a few code comments (config.py,config.toml,avatar_realtime_v3.py:401): reference HeyGen's internal config/backend. Low-sensitivity (no secrets), left intact — call if you want them genericized.heyular(Twitch) andukimsanov(GitHub) appear throughout tests and a couple docs as example submitter data. They're your own public handles, not internal/sensitive, so I left them. Easy to sweep to a neutral placeholder if you'd prefer.ARCHITECTURE.md§15: I reframed the "signoff" header to "Design decisions" but the numbered items keep a light first-person voice ("I'll commit ~50 paragraphs…"). Not sensitive; left as-is.— Ralu 🦦