Skip to content

docs: replace thesis blockquote with plain Why section#11

Merged
protosphinx merged 1 commit intomainfrom
docs/readme-rewrite
May 1, 2026
Merged

docs: replace thesis blockquote with plain Why section#11
protosphinx merged 1 commit intomainfrom
docs/readme-rewrite

Conversation

@protosphinx
Copy link
Copy Markdown
Member

What

De-slop pass matching the rest of the README rewrite batch. Replaces the `> The thesis.` deck callout AND the duplicated `## ✦ The flakiness problem` numbered list with a single `## Why` section in flowing prose. Renames `## ✦ Why not just mock?` to `## ✦ vs. mocks and snapshot tests` to drop the preemptive-defense framing.

The substantive content (mode docs, transcript format, comparison table, worked example, programmatic API, FAQ, roadmap) is unchanged.

Why

The thesis blockquote and the "flakiness problem" section both said the same thing in different words and both used the "X is flaky because Y" framing. The rewrite says it once in plain prose.

How

  • Thesis blockquote + flakiness section → one Why section in two paragraphs.
  • "Why not just mock?" header → "vs. mocks and snapshot tests".
  • Closing paragraph under that table tightened (no "Mocks lie. They drift." anaphora).

Test plan

  • No code change.
  • No em dashes (per repo writing-style rule).
  • All tables, code blocks, and links carried over.

Out of scope

  • Wider `## ✦ X` ornament headers stay for consistency with the other public erphq READMEs.
  • Any code or behaviour change.

The "> **The thesis.**" deck callout plus the "The flakiness
problem" numbered list duplicated each other and both leaned on
the "VCR for MCP" framing. Folded into a single Why section that
names the three flakiness modes in prose. Renamed "Why not just
mock?" to "vs. mocks and snapshot tests" to drop the
preemptive-defense framing. Tables, code examples, transcript
format, programmatic API, FAQ, and roadmap unchanged.
@protosphinx protosphinx merged commit b70d382 into main May 1, 2026
3 checks passed
@protosphinx protosphinx deleted the docs/readme-rewrite branch May 1, 2026 18:39
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