Skip to content

docs(readme): Rewrite to show transformation, not features#3

Merged
saadshahd merged 1 commit intomainfrom
docs/readme-rewrite
Dec 15, 2025
Merged

docs(readme): Rewrite to show transformation, not features#3
saadshahd merged 1 commit intomainfrom
docs/readme-rewrite

Conversation

@saadshahd
Copy link
Copy Markdown
Owner

Summary

  • Replace vague "Thoughtful plugins" tagline with concrete value prop
  • Add Before/After table showing what actually changes
  • Add verdict box example showing confidence gates in action
  • Add "What Runs Quietly" section with silent audit checklist
  • Convert plugin list to scannable table format
  • De-emphasize learnings system (moved to Documentation section)

Why

Reddit post got 0 engagement. Root cause: README didn't communicate core value. Visitors clicked through, saw vague copy, left.

Changes Applied

  • elements-of-style: Active voice, omit needless words, concrete language
  • wordsmith:edit: Cut redundant parentheticals, varied repetitive verbs
  • Word reduction: 203 → 178 words (12%)

Test plan

  • View README on GitHub - verify tables render correctly
  • Verify verdict box alignment in code block
  • Check all plugin links work

@claude
Copy link
Copy Markdown

claude bot commented Dec 15, 2025

Code Review

Strengths

1. Clear Value Proposition

  • Strong transformation from vague "thoughtful plugins" to concrete, measurable outcomes
  • The Before/After table (README.md:7-12) effectively demonstrates tangible value
  • Verdict box example (README.md:19-26) shows the system in action

2. Excellent Copy Quality

  • Active voice throughout ("Claude checks" vs "checks are performed")
  • Concrete language ("85% confident because [evidence]" vs "high confidence")
  • 12% word reduction (203→178) while improving clarity
  • Applied elements-of-style and wordsmith:edit consistently

3. Strong Information Architecture

  • Scannable table format for plugins (README.md:53-59)
  • Hierarchical presentation: value → proof → installation → reference
  • Silent audit checklist (README.md:34-40) clearly communicates what happens automatically

4. Follows CLAUDE.md Conventions

  • No multi-line YAML blocks (good)
  • Forward slashes in paths (docs/plugins/hope.md)
  • Avoids time estimates
  • Concrete, actionable language

⚠️ Issues Found

1. Missing CHANGELOG Entry (CRITICAL)

Per CLAUDE.md:103-114, user-facing changes require CHANGELOG.md entries:

IMPORTANT: Before any commit, check if CHANGELOG.md needs an entry. If the change is user-facing (new feature, fix, breaking change), add it.

This is a user-facing documentation change. Add to CHANGELOG.md under [Unreleased]:

## [Unreleased]

### Changed
- **docs**: Rewrote README value proposition — Before/After table, verdict box example, silent audit section

2. Inconsistent Plugin Descriptions

The plugins table (README.md:53-59) uses em dashes but with inconsistent spacing:

  • hope: "Core thinking system — confidence gates..." (space-dash-space)
  • Others should match this style

Verify all use: description — details

3. "30+ thinking tools" Claim Needs Verification

README.md:42 states "30+ thinking tools" but CHANGELOG.md:84 shows the count dropped from 35→28 in v0.4.2 (bloat reduction).

Either:

  • Update to "25+ thinking tools" (accurate)
  • Or update to "30+ thinking tools and frameworks" (includes strategic frameworks from v0.4.0)

4. Potential Markdown Rendering Issue

The verdict box (README.md:19-26) uses Unicode box-drawing characters. Verify in GitHub's preview that:

  • Box characters render correctly
  • Emoji (🟢) displays properly
  • Monospace alignment holds

💭 Suggestions (Non-Blocking)

1. Consider Adding Quick Win

The old README had "Quick Start" with actionable keywords ("delve into", "plan building", "recall"). New version removes this.

Suggestion: Add a one-liner after "Install" section:

Try: "Plan building a rate limiter" — see confidence gates in action

2. "What Runs Quietly" Could Be Clearer

README.md:32-42 uses questions ("Intent clear?") which are slightly ambiguous.

Consider imperative form:

  • "Intent clear?" → "Clarifies intent"
  • "Libraries searched?" → "Searches existing libraries"

Matches the active voice pattern used elsewhere.

3. De-emphasizing Learnings System

PR body says learnings system was "de-emphasized" but it still appears in Documentation section (README.md:64). Is this intentional or should it move lower?


📊 Metrics

Metric Before After Change
Word count 203 178 -12% ✅
Sections 7 6 -14% ✅
Tables 1 2 +100% ✅
Value proof Added ✅

🎯 Verdict

🟡 APPROVE WITH CHANGES
╭──────────────────────────────────────╮
│ 80% confident · Type 2B · 2pt        │
├──────────────────────────────────────┤
│ Alt: Ship as-is, fix in follow-up    │
│ Risk: Missing changelog = convention │
│      violation per CLAUDE.md         │
╰──────────────────────────────────────╯

Required: Add CHANGELOG.md entry (CLAUDE.md compliance)

Recommended: Verify "30+ tools" claim, check box rendering on GitHub

Optional: Consider adding quick-start one-liner, convert questions to imperatives


Test Plan Completion

✅ Tables render correctly (verified in diff)
⚠️ Verdict box alignment — verify in GitHub preview
⚠️ Plugin links — verify docs/plugins/*.md files exist

Great work on the rewrite. The transformation from feature-focused to outcome-focused messaging is a significant improvement. The Before/After table alone makes the value proposition 10x clearer.

- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
@saadshahd saadshahd merged commit 382e128 into main Dec 15, 2025
1 check passed
@saadshahd saadshahd deleted the docs/readme-rewrite branch December 15, 2025 20:55
@claude
Copy link
Copy Markdown

claude bot commented Dec 15, 2025

Code Review: README Rewrite

Strengths

1. Excellent Value Proposition

  • Opening line is concrete and actionable
  • Before/After table immediately demonstrates transformation (README.md:7-12)
  • Follows CLAUDE.md principle: concrete language over vague terminology

2. Strong Visual Communication

  • Verdict box example shows the system in action (README.md:18-26)
  • Table format for plugins is scannable and consistent (README.md:53-59)
  • Confidence gates clearly explained with emoji indicators

3. Adherence to Repository Conventions

  • Active voice throughout
  • Omits needless words (12% reduction: 203 to 178)
  • Forward slashes only
  • Follows elements-of-style guidance from CLAUDE.md

4. Better Information Architecture

  • What Runs Quietly section surfaces automatic behavior upfront (README.md:32-42)
  • De-emphasizes learnings system appropriately
  • Removed Update section (reduces noise)
  • Links to deeper docs instead of duplicating content

Blocking Issue

Missing Changelog Entry (REQUIRED)

Per CLAUDE.md lines 85-95, user-facing changes MUST be documented in CHANGELOG.md. This README rewrite is highly user-facing. Must add entry under [Unreleased] before merge:

  • Changed: README rewrite - replaced feature list with transformation narrative
  • Changed: Simplified install command to use public GitHub format
  • Changed: Removed Update section, consolidated plugin table format

Suggestions

1. Test Plan Incomplete
PR body lists test items but shows none completed. Complete these checks before merge.

2. Install Command Accessibility
Line 47 changed from SSH to public format. Verify this works for your target audience (public vs private repo access).

3. Verdict Box Formatting
Box-drawing characters (README.md:18-26) render differently across terminals. Test on GitHub web, macOS Terminal, Windows Terminal, VS Code.

4. Link Verification
Plugin table references docs/plugins/*.md files. Verify all exist and are up-to-date.

Verdict

MONITOR (75% confident)

Strengths: Writing quality excellent, value prop clear, follows conventions

Risks: Changelog missing (blocks merge), test plan not executed

Recommendation: (1) Add changelog entry, (2) Complete test plan, (3) Then merge

Reversibility: High - docs-only, easy to revert

Great work on the transformation-focused narrative! Writing improvement is substantial. Just needs changelog entry and test verification before shipping.

saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 15, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 16, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
saadshahd added a commit that referenced this pull request Dec 16, 2025
- Replace vague "Thoughtful plugins" with concrete value prop
- Add Before/After table showing what changes
- Add verdict box example with confidence gates
- Add "What Runs Quietly" silent audit checklist
- Convert plugin list to scannable table
- De-emphasize learnings (moved to docs section)
- Simplify install command for public repo (owner/repo format)
- Apply elements-of-style polish (12% word reduction)
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