Skip to content

docs(readme): sharpen the first impression for a public reader - #157

Merged
AlexTavor merged 1 commit into
mainfrom
pdd/readme-firstpass
Jul 13, 2026
Merged

docs(readme): sharpen the first impression for a public reader#157
AlexTavor merged 1 commit into
mainfrom
pdd/readme-firstpass

Conversation

@AlexTavor

Copy link
Copy Markdown
Owner

A cold-reader pass over the README before the repo goes public. Four reader perspectives (a cold visitor, a skeptical cloner, a hiring manager, and a docs editor) agreed the README is already strong, so this is six small changes, not a rewrite.

Credibility and framing (2)

  • Intro: one added sentence surfaces the durable idea and the only externally reproducible proof point up front, at the spot a skeptic decides whether to keep reading: pdd prove grades the tests, not the code, and a public SDK module reported 94% line coverage against a 0.68 mutation grade.
  • Gates section: names that SDK (unleash, an independent Apache-2.0 project) so the number is re-runnable by anyone, and introduces pdd grade, which was listed in Status but never shown as a runnable command.

Mechanical (4)

  • Added the pdd grade line to the runnable command block.
  • Removed five em-dashes (gate table, workflow paragraph, and the three "Also here" bullets) to match the project's plain-language voice.

Every number is audit-safe; the disproven counts are not used. All prose obeys the plain-language voice rules. Documentation only.

🤖 Generated with Claude Code

- Surface the durable thesis and the one externally reproducible proof point up front: pdd prove grades the tests, not the code, and a public unleash SDK module (94% line coverage vs 0.68 mutation grade) is re-runnable by anyone.

- Name unleash and add pdd grade where the oracle is explained (grade was listed in Status but never shown as runnable).

- Remove five em-dashes to match the project's plain-language voice.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@AlexTavor
AlexTavor merged commit 341b099 into main Jul 13, 2026
1 check passed
@AlexTavor
AlexTavor deleted the pdd/readme-firstpass branch July 13, 2026 13:11
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