docs: rewrite README in Simplified Technical English

[JarbasAl]

Rewrite the README for clarity: what the library provides, install, a usage example, the ovos-logs CLI reference, and links to related OVOS projects. Add the standard prev/home/next navigation footer to the five docs/*.md pages that were missing it.

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 the project overview with installation instructions, Python usage examples, command references, module documentation links, related projects, and licensing details.
  • Improved examples and reorganized guidance for available logging commands.
  • Added navigation links throughout the documentation to make related topics easier to discover and browse.

[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: b0dd3915-0405-4836-86a9-fc99b93170df

📥 Commits

Reviewing files that changed from the base of the PR and between b742ad3 and 405138e.

📒 Files selected for processing (6)

• README.md
• docs/events.md
• docs/fakebus.md
• docs/log.md
• docs/process-utils.md
• docs/utilities.md

---

📝 Walkthrough

Walkthrough

The README now contains expanded project, installation, usage, command, related-project, and license documentation. Module documentation pages now include footer links to related sections and the home page.

Changes

Documentation update

Layer / File(s)	Summary
README usage and project overview README.md	The README now documents utility modules, installation, FakeBus usage, ovos-logs commands, related projects, and licensing.
Module documentation navigation docs/events.md, docs/fakebus.md, docs/log.md, docs/process-utils.md, docs/utilities.md	Documentation pages now include links to related pages and the home page.

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

✨ 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]

Greetings! I've analyzed your changes and have some results to share. 🖖

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

🔍 Lint

Ensuring the quality bar remains high. 📈

❌ ruff: issues found — see job log

📋 Repo Health

Giving the repo a clean bill of health! 🛁

✅ All required files present.

Latest Version: 0.13.9a1

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

⚖️ License Check

I've verified the attribution of all third-party code. 👤

✅ No license violations found.

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

🔒 Security (pip-audit)

Checking the vault for any security leaks. 🔓

✅ No known vulnerabilities found (47 packages scanned).

🏷️ Release Preview

Drafting the future! Here's the changelog preview. 🖋️

Current: 0.13.9a1 → Next: 0.13.9a2

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: 0.13.9a2

Channel	Status	Note	Current Constraint
Stable	❌	Too new (must be <0.9.0)	ovos-utils>=0.8.1,<0.9.0
Testing	❌	Too new (must be <0.8.5)	ovos-utils>=0.8.4,<0.8.5
Alpha	✅	Compatible	ovos-utils>=0.13.9a1

📊 Coverage

Mapping out the 'known' vs 'unknown' in your code. 🗺️

✅ 85.2% total coverage

Files below 80% coverage (5 files)

File	Coverage	Missing lines
ovos_utils/log_parser.py	48.4%	225
ovos_utils/__init__.py	63.6%	16
ovos_utils/file_utils.py	74.4%	56
ovos_utils/thread_utils.py	76.9%	12
ovos_utils/geolocation.py	78.4%	22

Full report: download the coverage-report artifact.

🔨 Build Tests

The blueprints match the build! 📐

✅ All versions pass

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

---

Built by scripts, maintained by community 🤝