docs: cross-link the technical manual

[JarbasAl]

Summary

• Trim the README's persona and legacy AudioService sections to summaries linking the technical manual and docs/audio-service.md instead of restating them.

🤖 Generated with Claude Code

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 580caaec-058c-4606-a198-d9d4968708ae

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

Ping! I've got your results right here. 🛎️

I've aggregated the results of the automated checks for this PR below.

📊 Coverage

Checking the integrity of our test cases. 💎

✅ 98.2% total coverage

Per-file coverage (9 files)

File	Coverage	Missing lines
ovos_audio/__main__.py	93.8%	1
ovos_audio/audio.py	95.3%	16
ovos_audio/__init__.py	100.0%	0
ovos_audio/playback.py	100.0%	0
ovos_audio/service.py	100.0%	0
ovos_audio/transformers.py	100.0%	0
ovos_audio/tts.py	100.0%	0
ovos_audio/utils.py	100.0%	0
ovos_audio/version.py	100.0%	0

Full report: download the coverage-report artifact.

🔒 Security (pip-audit)

Scanning the horizon for any zero-day threats. 🌅

✅ No known vulnerabilities found (66 packages scanned).

⚖️ License Check

Checking the terms and conditions of your code. 📝

✅ No license violations found.

Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed.

🏷️ Release Preview

Ensuring the release schedule is still on track. 🗓️

Current: 2.1.1a2 → Next: 2.1.1a3

Signal	Value
Label	(none)
PR title	docs: cross-link the technical manual
Bump	alpha

✅ PR title follows conventional commit format.

---

🚀 Release Channel Compatibility

Predicted next version: 2.1.1a3

Channel	Status	Note	Current Constraint
Stable	❌	Too new (must be <0.5.0)	ovos-audio>=0.4.0,<0.5.0
Testing	❌	Too new (must be <2.0.0)	ovos-audio>=1.1.0,<2.0.0
Alpha	✅	Compatible	ovos-audio>=2.1.1a2

📋 Repo Health

Ensuring the repository remains in peak condition. 🏔️

✅ All required files present.

Latest Version: 2.1.1a2

✅ ovos_audio/version.py — Version file
✅ README.md — README
✅ LICENSE — License file
✅ pyproject.toml — pyproject.toml
⚠️ setup.py — setup.py
✅ CHANGELOG.md — Changelog
✅ ovos_audio/version.py has valid version block markers

🔌 Skill Tests (ovoscope)

I've verified the skill's 'error recovery' logic. 🩹

✅ 57/57 passed

✅ TestAudioCaptureSequence — 1/1
✅ TestAudioCaptureSequencePlayStop — 1/1
✅ TestAudioDuckingLowersVolume — 1/1
✅ TestAudioDuckingNoCurrentOnRecord — 1/1
✅ TestAudioDuckingOnRecord — 1/1
✅ TestAudioDuckingRestoresVolume — 1/1
✅ TestB64Audio — 1/1
✅ TestB64DualNamespaceDelivery — 6/6
✅ TestDefaultSessionAccepted — 1/1
✅ TestGetLanguagesTts — 1/1
✅ TestGetTrackLength — 1/1
✅ TestGetTrackPosition — 1/1
✅ TestInstantPlayBinaryData — 1/1
✅ TestInstantPlayWav — 1/1
✅ TestListBackends — 1/1
✅ TestMultipleSpeaks — 1/1
✅ TestMultipleSpeaksCaptureAllEvents — 1/1
✅ TestNoSpuriousEventsAfterShutdown — 1/1
✅ TestOcpFlagIntegration — 1/1
✅ TestOpmG2pQuery — 1/1
✅ TestOpmTtsQuery — 1/1
✅ TestPlayHttpTrack — 1/1
✅ TestPlayPauseResume — 1/1
✅ TestPlaybackStopDualSubscription — 2/2
✅ TestPlaylistNextPrev — 1/1
✅ TestQueueSound — 1/1
✅ TestQueueSoundWithBinaryData — 1/1
✅ TestQueueTracks — 1/1
✅ TestRestoreVolumeOnHandled — 1/1
✅ TestRestoreVolumeOnHandledWhileSpeaking — 1/1
✅ TestSeekBackward — 1/1
✅ TestSeekForward — 1/1
✅ TestSessionValidation — 1/1
✅ TestSetTrackPosition — 1/1
✅ TestSpeakAfterStop — 1/1
✅ TestSpeakBasic — 1/1
✅ TestSpeakExpectResponse — 1/1
✅ TestSpeakNonDefaultSessionRejected — 1/1
✅ TestSpeakResetMockTts — 1/1
✅ TestSpeakSpecTopic — 1/1
✅ TestSpeakStatus — 1/1
✅ TestSpeakStatusNotSpeaking — 1/1
✅ TestSpeakWithIdentContext — 1/1
✅ TestStop — 1/1
✅ TestStopBeforeGuardIsIgnored — 1/1
✅ TestStopTTS — 1/1
✅ TestTrackEndCallbackEmission — 1/1
✅ TestTrackInfo — 1/1
✅ TestTrackStartCallbackEmission — 1/1
✅ TestTtsStopDualTopic — 2/2

🚌 Bus Coverage

Measuring the footprint of your bus testing efforts. 👣

⚠️ Bus coverage report unavailable — check the job log.

🔍 Lint

I've finished the analysis you requested. 💡

❌ ruff: issues found — see job log

🔗 Downstream Dependents

I've gathered the facts for your review. 📖

No dependents found for ovos-audio

🔨 Build Tests

Mixing the ingredients and seeing if the cake rises! 🎂

✅ All versions pass

Python	Build	Install	Tests
3.10	✅	✅	✅
3.11	✅	✅	✅
3.12	✅	✅	✅
3.13	✅	✅	✅
3.14	✅	✅	✅

---

From the digital workshop of OpenVoiceOS. 🛠️