README.md updated#1606
Conversation
Co-authored-by: mackbel mc <makbel.mc@gmail.com>
📝 WalkthroughWalkthroughREADME.md is restructured: the hero/badges and introductory narrative are replaced with an Overview, Quick Start (with shell/PowerShell install commands for three platforms), Key Features bullets, Why OpenHuman section, streamlined Developer Resources links, and updated OpenHuman Compared content. Star History chart and Hall of Fame copy are removed. ChangesREADME documentation restructuring
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ 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.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README.md (1)
47-47: 💤 Low valueConsider a more maintainable integration count.
The specific "118+" count will require manual updates as integrations are added or removed. Consider rephrasing to "100+ OAuth integrations" or "extensive OAuth integrations" to reduce maintenance overhead.
🤖 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 47, Update the README sentence that begins with "Integrated connectors:" to use a more maintainable count or non-specific wording instead of "118+"; for example, change "118+ OAuth integrations" to "100+ OAuth integrations" or "extensive OAuth integrations" so the phrase in the README (the "Integrated connectors:" line) no longer requires manual updates when integrations change.
🤖 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.
Nitpick comments:
In `@README.md`:
- Line 47: Update the README sentence that begins with "Integrated connectors:"
to use a more maintainable count or non-specific wording instead of "118+"; for
example, change "118+ OAuth integrations" to "100+ OAuth integrations" or
"extensive OAuth integrations" so the phrase in the README (the "Integrated
connectors:" line) no longer requires manual updates when integrations change.
graycyrus
left a comment
graycyrus
left a comment
There was a problem hiding this comment.
PR Review — README.md restructure
Walkthrough
This PR is a structural and tonal overhaul of the README by an external contributor. It moves from a marketing-narrative style (badges, star history charts, "Context in minutes" storytelling, named competitor callouts) toward a cleaner technical reference format with explicit Quick Start sections split by OS, a condensed feature list, and a simplified comparison table.
The overall direction is reasonable — bloated READMEs with star charts and follow-links are noisy for developers evaluating a project — but a few cuts go too far.
Changes
| File | Summary |
|---|---|
README.md |
Restructured from narrative marketing copy to sectioned reference; removed TrendShift badge, star history chart, creator follow-link, named competitors, and "hall of fame" framing; added OS-split Quick Start and cleaner features list |
Actionable comments
[major] Creator attribution removal
The PR removes the Follow @senamakel (Creator) link. This is the creator's personal attribution in their own project's README. An external contributor removing it — without discussion in the PR description, no linked issue, and no maintainer approval — is outside the scope of a documentation cleanup PR. Even if the restructuring is accepted, this removal should be a conscious decision by the maintainer.
Action: Restore the creator attribution, or get explicit maintainer sign-off before merging.
[major] Comparison table loses all signal value
The original table named specific tools (Claude Cowork, OpenClaw, Hermes Agent) so readers could verify claims independently. The replacement "Typical alternative" column is an unverifiable marketing assertion — it can't be fact-checked and reads weaker than naming real comparators. If there's a concern about accuracy, the fix is to update the data or add a comparison date, not anonymize everything.
Action: Restore named competitor columns, or name at least one specific tool per row so the table retains falsifiability.
[minor] Alt text fix is correct ✅
"The Tet" → "OpenHuman demo" is a genuine fix — keep this regardless of other decisions.
Nitpicks
- PR description is entirely empty — all template sections (Summary, Problem, Solution) are unfilled and the checklist is unchecked. For a docs-only change this is low effort to fill in and matters for commit history.
- Head branch is
mainon the contributor's fork — means they committed directly to their default branch. Not blocking, but makes iteration harder. Worth a note for future PRs. - Star history chart removal and "Hall of Fame" language cleanup are fine — noise reduction without information loss.
What looks good
- OS-split Quick Start (macOS/Linux vs Windows) is a genuine improvement
- "Why OpenHuman" section is cleaner and more scannable
- Developer Resources consolidation is well-organized
- No code, config, deps, or tests touched — purely documentation
Questions for @brukcodes
- Was removing the
@senamakelcreator link intentional, or was it caught up in the cleanup? - What's the rationale for anonymizing the comparison table rather than updating the named tools?
Bottom line: The structural improvements are real, but two items need resolution before merge: (1) creator attribution removal needs maintainer sign-off, and (2) the comparison table should name real tools or be removed — "Typical alternative" is weaker than what it replaced.
|
the current readme is fine as it but thanks for the pr |
3 participants
Summary
Problem
Solution
Submission Checklist
diff-cover) meet the gate enforced by.github/workflows/coverage.yml. Runpnpm test:coverageandpnpm test:rustlocally; PRs below 80% on changed lines will not merge.docs/TEST-COVERAGE-MATRIX.mdreflect this change (orN/A: behaviour-only change)## Relateddocs/RELEASE-MANUAL-SMOKE.md)Closes #NNNin the## RelatedsectionImpact
Related
AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
Validation Run
pnpm --filter openhuman-app format:checkpnpm typecheckValidation Blocked
command:error:impact:Behavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit