redhat-et / redhat-et/ripwire

De-AI-ify the README

Open
#73 10 comments 7 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
2.1k
Forks
125
Avg merge
5h 42m
Merged PRs (30d)
136

Description

I find this project very interesting, but the README is super hard to read because it's full of Claude writing. Claude has a tendency to turn everything into a mini-TED-talk and make it seem like every sentence is important. This just makes everything less clear.

Also, the README spends a lot of time on marketing, showing benchmark numbers etc, but I just want to know how it works, why it works, and how to use it. I have to sift through a ton of mini-TED-talk text to figure all that out.

It would be helpful if a skilled human rewrites the README. Or at the very least, prompt the AI to write better. You may not want to use Claude for that: in my experience Claude is terrible at following writing style instructions and insists on writing Claudish.

Contributor guide

Open the contributing guide

Research direction

Start by reading the current README to identify the marketing, benchmark, and overly elaborate sections. Rewrite it around how ripwire works, why it works, and how to use it, with clearer and more concise prose; the README is done when those essentials are easy to find without promotional text obscuring them.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.