Skip to content

docs: rewrite README hero with pain-first voice#38

Merged
oren153 merged 1 commit intomainfrom
docs/readme-hn-voice
Mar 10, 2026
Merged

docs: rewrite README hero with pain-first voice#38
oren153 merged 1 commit intomainfrom
docs/readme-hn-voice

Conversation

@oren153
Copy link
Member

@oren153 oren153 commented Mar 10, 2026

Summary

  • Lead with the problem ("stop staring at logs") instead of feature-speak, matching the voice from the HN post
  • Add the aggregation punch line inline: "24 out of 51 failures are missing escalations — so you know exactly what to fix first"
  • Move "runs locally" to the hero section where trust matters most
  • Tighten the privacy note to avoid redundancy

Test plan

  • Verify README renders correctly on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Refreshed feature descriptions with improved clarity and UI focus.
    • Enhanced production trace handling documentation, detailing the root cause analysis workflow.
    • Clarified privacy model: tool runs locally with only LLM API calls leaving the machine.
    • Added outcome flow for aggregating root causes across conversations.

Lead with the problem ("stop staring at logs") instead of features,
add the aggregation punch line, and move "runs locally" to the hero.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@oren153 oren153 merged commit 92c8001 into main Mar 10, 2026
@coderabbitai
Copy link

coderabbitai bot commented Mar 10, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1607aea5-447a-49cf-b69b-a8c378efc41a

📥 Commits

Reviewing files that changed from the base of the PR and between 32eb7de and 386069b.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README.md has been repositioned to emphasize the project as a production-workflow debugger, highlighting production trace analysis, root-cause aggregation through step-by-step LLM replay, and local execution with privacy preservation through API-only external calls.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Refocused project description to emphasize production trace debugging workflow, including extraction of behavioral rules, LLM-as-judge step-by-step replay, failure attribution, root-cause aggregation across conversations, and privacy assurance (local execution, LLM API calls only). Updated "Fix the right thing" outcome and "How it works" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A readme refined, so clear and so bright,
From traces to fixes, we debug it right,
Step-by-step replays show where things went wrong,
Root causes gathered, our debugging song!
Local and private, with magic LLM—
The workflow debugger, our hero's anthem!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/readme-hn-voice

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.

@oren153 oren153 deleted the docs/readme-hn-voice branch March 10, 2026 18: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