Skip to content

docs: rewrite README in Simplified Technical English - #168

Merged
JarbasAl merged 1 commit into
devfrom
docs/ste-readme
Aug 1, 2026
Merged

docs: rewrite README in Simplified Technical English#168
JarbasAl merged 1 commit into
devfrom
docs/ste-readme

Conversation

@JarbasAl

@JarbasAl JarbasAl commented Aug 1, 2026

Copy link
Copy Markdown
Member

Rewrites README.md and docs/index.md for clarity, removing marketing adjectives and em dashes while keeping every fact, table, and link. Adds a Related projects section linking sibling org repos.

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
    • Reorganized and expanded project documentation with clearer setup instructions, requirements, plugin and model details, hardware optimization guidance, and related project information.
    • Clarified image capabilities, system dependencies, overlays, default credentials, CI validation, and Raspberry Pi OS customization.
    • Updated introductory guidance to highlight local data handling and no required cloud account or subscription.
    • Reformatted setup instructions and preserved relevant links.

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

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a0c1a1a7-ec77-4874-aed7-11c48ce030b3

📥 Commits

Reviewing files that changed from the base of the PR and between b0f066f and 12439e1.

📒 Files selected for processing (2)
  • README.md
  • docs/index.md

📝 Walkthrough

Walkthrough

The pull request revises README.md and docs/index.md. It clarifies raspOVOS features, setup instructions, hardware requirements, system customization, models, server use, related projects, and licensing.

Changes

Documentation refresh

Layer / File(s) Summary
Project overview and setup
README.md
The README now includes clearer project context, navigation, setup references, hardware guidance, image behavior, credentials, server notes, plugins, related projects, and license information.
Image, runtime, and model documentation
README.md
The README clarifies Raspberry Pi OS customization, system configuration, overlays, runtime components, model setup, and ZRAM wording.
Documentation site introduction and setup
docs/index.md
The documentation site now uses shorter introductory and setup text, with explicit local-data handling and unchanged server behavior. Onboarding steps retain the existing image, credential, hostname, and username instructions.

Estimated code review effort: 1 (Trivial) | ~5 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

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

@JarbasAl
JarbasAl marked this pull request as ready for review August 1, 2026 15:35
@JarbasAl
JarbasAl merged commit 374f5f5 into dev Aug 1, 2026
3 checks passed
@JarbasAl
JarbasAl deleted the docs/ste-readme branch August 1, 2026 15:36
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