Skip to content

docs: rewrite README in Simplified Technical English - #119

Draft
JarbasAl wants to merge 1 commit into
devfrom
docs/ste-readme
Draft

docs: rewrite README in Simplified Technical English#119
JarbasAl wants to merge 1 commit into
devfrom
docs/ste-readme

Conversation

@JarbasAl

Copy link
Copy Markdown
Member

Rewrites README.md and all docs/*.md pages in Simplified Technical English for clarity: shorter sentences, active voice, no marketing language, no em-dashes/semicolons. Adds a navigation footer to every docs page (index.md exempt) and links related OpenVoiceOS projects from the README. No facts, features, or code examples were changed.

Rewritten by Claude Sonnet 5 using the ste-writing skill (authored and reviewed by Claude Fable 5); linted with ste_lint.py.

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

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: 17fa6b2a-4ae3-43dd-b10d-509674b0b226

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

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

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown

Hello there! I've processed your latest changes. 🌊

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

📋 Repo Health

I've performed a health check on the project. 🏥

✅ All required files present.

Latest Version: 1.6.1a1

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

🔍 Lint

I've finished the heavy lifting on this check. 🏋️‍♂️

ruff: issues found — see job log

🔒 Security (pip-audit)

I've checked the security of our API endpoints. 🌐

✅ No known vulnerabilities found (79 packages scanned).

🏷️ Release Preview

The release preview report is now officially ready. 📁

Current: 1.6.1a1Next: 1.6.1a2

Signal Value
Label (none)
PR title docs: rewrite README in Simplified Technical English
Bump alpha

✅ PR title follows conventional commit format.


🚀 Release Channel Compatibility

Predicted next version: 1.6.1a2

Channel Status Note Current Constraint
Stable Not in channel -
Testing Too new (must be <1.0.0) ovoscope>=0.7.2,<1.0.0
Alpha Compatible ovoscope>=1.6.1a1

⚖️ License Check

Verifying the legal status of all dependencies. 📜

✅ No license violations found.

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

🔨 Build Tests

The build is complete. No hard hats required. 👷‍♂️

✅ All versions pass

Python Build Install Tests
3.10
3.11
3.12
3.13
3.14

📊 Coverage

Ensuring we've got all the bases covered! ⚾

53.7% total coverage

Files below 80% coverage (18 files)
File Coverage Missing lines
ovoscope/simple_listener.py 0.0% 55
ovoscope/tts_intelligibility.py 0.0% 190
ovoscope/version.py 0.0% 5
ovoscope/intent_cases.py 14.0% 141
ovoscope/classic_listener.py 18.2% 117
ovoscope/pipeline.py 31.0% 78
ovoscope/ocp.py 31.8% 58
ovoscope/cli.py 32.8% 162
ovoscope/e2e.py 34.9% 99
ovoscope/pytest_plugin.py 41.4% 222
ovoscope/listener.py 56.2% 123
ovoscope/media.py 57.2% 101
ovoscope/voice_loop.py 58.3% 115
ovoscope/__init__.py 59.2% 317
ovoscope/coverage.py 63.3% 69
ovoscope/audio.py 64.2% 112
ovoscope/media_provider.py 64.9% 20
ovoscope/wakeword_probe.py 75.0% 20

Full report: download the coverage-report artifact.


Processing... Done! Have a productive day! ☕

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