Conversation
This commit updates README_CN.md to match the current Electron app positioning and install flow. It adds product positioning, badges, docs links, one-click install commands, source-run instructions, migration guidance for Tauri users, workspace and feature highlights, and refreshed sponsor/support sections.
|
[Low risk] Updates Chinese README documentation for Electron release. The documentation change appears safe to merge. SummaryThe Chinese README now describes the maintained Electron app, its installation and source-run paths, migration guidance, features, and support options. Reviews (1) · Last reviewed commit: "Refresh Chinese README for Electron laun..." |
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: debpalash/VoiceStudio/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe Chinese README updates VoiceStudio’s product overview, installation and development guidance, and support information. It describes Electron as the sole desktop app and Web UI, and identifies version 0.5.3 as the final Tauri release. ChangesChinese README
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~8 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to No actionable issue is established in the documentation update, so it is mergeable subject to normal checks. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 8 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (8 passed)
Full details: Title checkResolution Rename the PR using a conventional-commit title with a scope, for example
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Consolidate community engine, workflow, dictation, and setup fixes with the Electron composer, sidebar, and voice UI. Fix review findings in engine residency, remote exports, backup cleanup, bounded compressed-audio decoding, and reference preprocessing. Preserve contributor credits in CHANGELOG.md and leave the app version unchanged. Supersedes #2325, #2338, #2368, #2377, #2379, #2380, #2383, #2384, #2387, #2390, #2391, #2392, #2393, #2395, #2400, #2401, #2402, #2409, #2410, and #2412.
|
Implemented and merged through #2419. Contributor credit is preserved in CHANGELOG.md. |
2 participants
This commit updates README_CN.md to match the current Electron app positioning and install flow. It adds product positioning, badges, docs links, one-click install commands, source-run instructions, migration guidance for Tauri users, workspace and feature highlights, and refreshed sponsor/support sections.
Summary
README_CN.md had been left behind by 15 commits: its last change was
3f1f9bf9(2026-09-16), while the English README was rewritten throughd6348b56(2026-09-26). This PR re-translates that delta so the Chinese README states the current Electron-only positioning, install paths, and documentation set. Documentation only — no runtime, build, dependency, or version changes.Changes
VoiceStudio, powered by k2-fsa/OmniVoice) and a link todocs/feature-catalog.md.curl -fsSL https://voicestudio.sh/install | sh) with its--version/--main/--uninstallvariants, prerequisites, and a link todocs/install/script.md.docs/install/agent.md.cd electron && bun run devtobun install && bun run setup:api && bun run dev. The old form skipped Python dependency preparation, so the shell could fail to start the backend; also added thebun run smoke-testnote.docs/electron-migration.md.<details>block and added the extra desktop screenshot, matching the English README.voicestudio,voicestudio-maintainer).docs/media/sponsor-slot.svgplacement image.<sub>caption under the demo GIF and the "still in active development" sentence.Type
Testing
<img src>targets in README_CN.md resolve to existing files; no dead links.<details>, 1<table>, 3 fenced code blocks.pytest tests/test_no_hardcoded_cjk.py tests/test_voicestudio_branding.py→ 10 passed. README_CN.md is allowlisted in the CJK check, and the branding test asserts on README.md, which is unchanged.Checklist
package.json,pyproject.toml,backend/core/version.py, and lockfiles — N/A, no version bump requestedtests/fixtures/omnivoice_data/still loads green on thesmoke-matrixCI job (macOS + Windows + Linux) — N/A, documentation-only changeThe Chinese README now documents VoiceStudio’s Electron positioning, installation options, agent setup, migration guidance, and updated features. This aligns the documentation with the current app and install flow. No runtime changes are reported; test results and documentation-link validation are not independently confirmed.