Update README.md by zik6824 · Pull Request #1774 · tinyhumansai/openhuman

zik6824 · 2026-05-15T00:38:59Z

Summary

What changed and why.
Keep this to 3-6 bullets focused on user-visible or architecture-impacting changes.

Problem

What issue or risk this PR addresses.
Include context needed for reviewers to evaluate correctness quickly.

Solution

How the implementation solves the problem.
Note important design decisions and tradeoffs.

Submission Checklist

If a section does not apply to this change, mark the item as N/A with a one-line reason. Do not delete items.

Tests added or updated (happy path + at least one failure / edge case) per Testing Strategy
Diff coverage ≥ 80% — changed lines (Vitest + cargo-llvm-cov merged via diff-cover) meet the gate enforced by .github/workflows/coverage.yml. Run pnpm test:coverage and pnpm test:rust locally; PRs below 80% on changed lines will not merge.
Coverage matrix updated — added/removed/renamed feature rows in docs/TEST-COVERAGE-MATRIX.md reflect this change (or N/A: behaviour-only change)
All affected feature IDs from the matrix are listed in the PR description under ## Related
No new external network dependencies introduced (mock backend used per Testing Strategy)
Manual smoke checklist updated if this touches release-cut surfaces (docs/RELEASE-MANUAL-SMOKE.md)
Linked issue closed via Closes #NNN in the ## Related section

Impact

Runtime/platform impact (desktop/mobile/web/CLI), if any.
Performance, security, migration, or compatibility implications.

AI Authored PR Metadata (required for Codex/Linear PRs)

Keep this section for AI-authored PRs. For human-only PRs, mark each field N/A.

Linear Issue

Key:
URL:

Commit & Branch

Branch:
Commit SHA:

Validation Run

Validation Blocked

command:
error:
impact:

Behavior Changes

Intended behavior change:
User-visible effect:

Parity Contract

Legacy behavior preserved:
Guard/fallback/dispatch parity checks:

Duplicate / Superseded PR Handling

Duplicate PR(s):
Canonical PR:
Resolution (closed/superseded/updated):

Summary by CodeRabbit

Documentation
- Streamlined README startup instructions for improved clarity. Users can now easily find directions to download from tinyhumans.ai/openhuman or run the installation commands.

coderabbitai · 2026-05-15T00:39:13Z

📝 Walkthrough

Walkthrough

A single line in README.md is updated: the "To install or get started…" instruction is replaced with a shorter "To get started…" line that directs users to tinyhumans.ai/openhuman or to run install commands.

Changes

README Documentation

Layer / File(s)	Summary
Getting started instructions `README.md`	The introductory "To install or get started" sentence is replaced with concise "To get started" text directing users to download from the website or run install commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

tinyhumansai/openhuman#1500: Updates to README.md startup and context copy with wording refinements and instruction tweaks.
tinyhumansai/openhuman#1388: Documentation-only edits to README.md startup instructions and feature descriptions.
tinyhumansai/openhuman#1449: Modifies README.md startup and installation content guidance.

Poem

🐰 One line, one tweak, the startup gleams,
"Get started" now—no lengthy schemes,
The path is clear, the words ring true,
A rabbit's edit, tried and new! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Update README.md' is vague and does not convey the specific change made: updating startup instructions from 'To install or get started...' to 'To get started...' with new download/install guidance.	Consider a more specific title such as 'Update README startup instructions' or 'Simplify README getting started section' to better communicate the actual change to reviewers.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

Generate code and open pull requests
Plan features and break down work
Investigate incidents and troubleshoot customer tickets together
Automate recurring tasks and respond to alerts with triggers
Summarize progress and report instantly

Built for teams:

Shared memory across your entire org—no repeating context
Per-thread sandboxes to safely plan and execute work
Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

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 and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 33: The README line "To get started, download from
tinyhumans.ai/openhuman or run" is incomplete—replace that fragment with a full
sentence that tells users what to run or where to find the run command; for
example update the sentence to "To get started, download from
tinyhumans.ai/openhuman or run the quick-start installer/CLI as described in
tinyhumans.ai/openhuman/docs" so the fragment "To get started, download from
tinyhumans.ai/openhuman or run" is completed and points readers to the next
action or docs.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 88266333-71e1-48cd-b037-512580dab8e7

📥 Commits

Reviewing files that changed from the base of the PR and between 3165306 and 6062af6.

📒 Files selected for processing (1)

README.md

coderabbitai · 2026-05-15T00:40:24Z

 > **Early Beta**: Under active development. Expect rough edges.

-To install or get started, either download from the website over at [tinyhumans.ai/openhuman](https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme) or run
+To get started, download from tinyhumans.ai/openhuman or run


⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Complete the getting-started sentence for clarity.

The sentence ends abruptly at “or run”, which makes the onboarding instruction feel broken.

✏️ Suggested wording

-To get started, download from tinyhumans.ai/openhuman or run +To get started, download from https://tinyhumans.ai/openhuman or run the commands below:

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

To get started, download from tinyhumans.ai/openhuman or run

To get started, download from https://tinyhumans.ai/openhuman or run the commands below:

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 33, The README line "To get started, download from tinyhumans.ai/openhuman or run" is incomplete—replace that fragment with a full sentence that tells users what to run or where to find the run command; for example update the sentence to "To get started, download from tinyhumans.ai/openhuman or run the quick-start installer/CLI as described in tinyhumans.ai/openhuman/docs" so the fragment "To get started, download from tinyhumans.ai/openhuman or run" is completed and points readers to the next action or docs.

zik6824 · 2026-05-15T00:44:25Z

Minor copy edits — simplified phrasing to be more concise and straightforward.

zik6824 · 2026-05-15T00:44:38Z

Minor copy edits — simplified phrasing to be more concise and straightforward.

zik6824 · 2026-05-15T00:51:07Z

Minor copy edits — simplified phrasing to be more concise and straightforward.

senamakel · 2026-05-15T04:05:35Z

no this is making the readme worse

Update README.md

6062af6

zik6824 requested a review from a team May 15, 2026 00:39

coderabbitai Bot requested changes May 15, 2026

View reviewed changes

zik6824 closed this May 15, 2026

zik6824 reopened this May 15, 2026

senamakel closed this May 15, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md#1774

Update README.md#1774
zik6824 wants to merge 1 commit into
tinyhumansai:mainfrom
zik6824:patch-1

zik6824 commented May 15, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 15, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

❌ Failed checks (1 inconclusive)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot May 15, 2026

Uh oh!

zik6824 commented May 15, 2026

Uh oh!

zik6824 commented May 15, 2026

Uh oh!

zik6824 commented May 15, 2026

Uh oh!

senamakel commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	To get started, download from tinyhumans.ai/openhuman or run
	To get started, download from https://tinyhumans.ai/openhuman or run the commands below:

Conversation

zik6824 commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Problem

Solution

Submission Checklist

Impact

Related

AI Authored PR Metadata (required for Codex/Linear PRs)

Linear Issue

Commit & Branch

Validation Run

Validation Blocked

Behavior Changes

Parity Contract

Duplicate / Superseded PR Handling

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

❌ Failed checks (1 inconclusive)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot May 15, 2026

Choose a reason for hiding this comment

Uh oh!

zik6824 commented May 15, 2026

Uh oh!

zik6824 commented May 15, 2026

Uh oh!

zik6824 commented May 15, 2026

Uh oh!

senamakel commented May 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zik6824 commented May 15, 2026 •

edited

Loading

coderabbitai Bot commented May 15, 2026 •

edited

Loading