Repository navigation
Prepare VoiceForge for open-source launch - #1
Merged
Merged
Conversation
Replace bare except-pass with logged/explicit fallbacks and sort Chatterbox imports so lint-and-test passes.
Require an explicit consent acknowledgement before clone, default to openvoice-v2, and load engines/voices when the API has no token configured.
Add clear safety language that consent is a declaration (not identity proof) and that optional watermarking is a weak fingerprint, not forensic proof.
Document per-engine readiness, hardware paths, and separate adapter vs model-weight licence terms without overstating commercial use.
Cover onboarding, deployment boundaries, client integration, demo capture rules, and manual GitHub metadata settings.
Improve open-source onboarding with CoC, contributing guide, roadmap/changelog, GitHub templates, and make start-cpu/stop/logs/smoke targets.
Lead with the product promise, Studio screenshot, responsible-use notice, and engine matrix; move milestone detail to ROADMAP and document pending verified audio captures.
GitHub often blanks CSS-class SVGs in markdown images; render architecture and engine flows via Mermaid and keep simplified inline SVGs as file links.
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.
Summary
RESPONSIBLE_USE.md,docs/CONSENT.md, Studio consent checkbox (API still requiresconsent=true), honest “declaration ≠ verification” language.docs/ENGINES.md+docs/ENGINE_LICENSING.mdwith categorized engines and licence separation (MIT app ≠ model terms).docs/FIRST_CLONE.md,docs/SELF_HOSTING.md,docs/REEL_STUDIO.md, Makefile helpers (start-cpu/stop/logs/smoke-openvoice).docs/WATERMARKING.md— optional weak fingerprint, not forensic proof.docs/DEMO_CAPTURE.md/docs/assets/AUDIO_SOURCES.md.S110/ import-order failures that were failinglint-and-testonmain.openvoice-v2.README before → after
Authentic screenshots and audio assets
docs/assets/voiceforge-studio.pngdocs/assets/engine-comparison.svgdocs/assets/clone-flow.gifdocs/clone-flow.svglinkeddocs/assets/audio/*.mp3Engine support matrix
See
docs/ENGINES.md. CPU e2e verified claims retained only foropenvoice-v2,xtts-v2,f5-tts. GPU still marked verification needed.Responsible-use and consent changes
Docs + Studio checkbox. No identity-verification infrastructure added. Optional consent metadata fields documented as future/not implemented.
Licensing review
docs/ENGINE_LICENSING.md+ README/NOTICE pointers. XTTS CPML non-commercial preserved.Security review
No telemetry/cloud TTS added. Auth/CORS/resource limits unchanged. SECURITY.md expanded for voice-data incidents. Studio still works with bearer when configured.
Tests executed
ruff check app/ scripts/ tests/— passpytest tests/ -q— 49 passeddocker compose -f docker/docker-compose.yml config— OKpip-audit— not re-run in this pass (available viapip install -e ".[dev]")Engines not tested / why
.venvhad 0/9 engines ready (ML stacks not installed); Docker model run not executed in this PR to avoid long downloadsRemaining manual GitHub settings
Follow
docs/GITHUB_METADATA.md: description, topics, social preview image/text.Test plan
make start-cpu; confirm consent checkbox blocks clone when uncheckedDo not merge until you are satisfied with docs + CI.
Made with Cursor