docs: rewrite README in Simplified Technical English

[JarbasAl]

Rewrites README.md and docs/*.md for clarity, keeping every fact, code block, and license section. Adds an install/usage section to the README, a related-projects list, and standard footer navigation (relative links) across the docs/ pages.

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

Summary by CodeRabbit

• Documentation
  • Expanded project documentation with installation, usage, configuration, licensing, and related-project information.
  • Clarified backend options, Rust backend compatibility, limitations, and benchmark results.
  • Updated configuration guidance, including TLS, certificates, defaults, filtering, and overrides.
  • Improved event bus, server, startup, shutdown, and client connection documentation.
  • Refined terminology, formatting, navigation, and command examples throughout the documentation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2b7f4e4c-12e9-471a-9331-d5f892727feb

📥 Commits

Reviewing files that changed from the base of the PR and between 85278a9 and 858a506.

📒 Files selected for processing (6)

• README.md
• docs/backends.md
• docs/configuration.md
• docs/events.md
• docs/index.md
• docs/server.md

---

📝 Walkthrough

Walkthrough

The pull request revises the README and technical documentation. It adds usage and navigation content and clarifies configuration, server behavior, message forwarding, backend compatibility, TLS limitations, and benchmark methodology. No functional code or public API declarations change.

Changes

Documentation clarification

Layer / File(s)	Summary
Project overview and navigation README.md, docs/index.md	The documentation now covers installation, usage, project layout, related documentation, services, GUI clients, and licensing.
Configuration and server behavior docs/configuration.md, docs/server.md	The documentation clarifies configuration sources, overrides, TLS, message-size handling, debug-only filtering, fan-out behavior, and server shutdown.
Message-bus events and filtering docs/events.md	The documentation states that messages are forwarded unchanged and that filtering affects debug logs only.
Backend compatibility and benchmarks docs/backends.md	The documentation clarifies Tornado and webrockets behavior, Rust configuration, compatibility limits, and benchmark methodology and results.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• OpenVoiceOS/ovos-messagebus#51: Updates the same backend, configuration, events, index, and server documentation areas.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/ste-readme

---

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]

The results of your automated verification are here! 📜

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

🔒 Security (pip-audit)

Ensuring our encryption is top-notch. 🔐

✅ No known vulnerabilities found (55 packages scanned).

📊 Coverage

Is the code fully hydrated with tests? Let's see! 💧

⚠️ 78.2% total coverage

Per-file coverage (8 files)

File	Coverage	Missing lines
ovos_messagebus/version.py	0.0%	5
ovos_messagebus/ssl_utils.py	25.9%	20
ovos_messagebus/__main__.py	75.4%	14
ovos_messagebus/event_handler.py	81.7%	11
ovos_messagebus/backends/webrockets_backend.py	96.0%	3
ovos_messagebus/__init__.py	100.0%	0
ovos_messagebus/backends/__init__.py	100.0%	0
ovos_messagebus/load_config.py	100.0%	0

Full report: download the coverage-report artifact.

🔍 Lint

The automated results are now available for your perusal. 📂

❌ ruff: issues found — see job log

⚖️ License Check

Making sure we're playing by the open-source rules. 🎲

✅ No license violations found.

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

🔨 Build Tests

Checking the structural resonance of the codebase. 🔊

✅ All versions pass

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

---

Crafting quality through automation. 🧪