Skip to content

Replace em-dashes and deposition framing in public docs - #46

Merged
jasoneplumb merged 2 commits into
mainlinefrom
docs-voice-pass
Sep 16, 2026
Merged

jasoneplumb merged 2 commits into
mainlinefrom
docs-voice-pass

Conversation

@jasoneplumb

Copy link
Copy Markdown
Owner

Summary

  • Pass 1 (punctuation): replaced every em-dash in README.md and docs/results.md prose/tables with plain punctuation (comma, colon, semicolon, or parentheses) matched to the clause; en-dashes in numeric ranges (5-20 s, 15 -> 20, 25-2,890 ms) are untouched.
  • Pass 2 (framing): renamed the README "## Evidence" heading to "## Results". No other deposition-style phrases ("what it does not establish", "not independently verifiable", "a reader can/cannot check", "rests on my account") were present in README.md.
  • docs/results.md received punctuation-only edits per the critical constraint: it's a cited source for the external claims register. All load-bearing figures and phrasing are unchanged (11,300/23-instrumented-rides comparison, 23/23 replays, 57,783-step corpus, 22-of-49 undelivered dispatches, the failed max_notice_s policy change, the uncompared tail step).
  • docs/field-reverification.md had zero em-dashes to begin with and needed no edits; its load-bearing phrases ("confirms recorded comparison coverage, not independent firmware identity"; "Removing the notice window as well increases cues from 42 to 83") are untouched.
  • No code, code blocks, or diagrams were touched. No new em-dashes, and no instances of leverage/robust/seamless/delve were introduced.

Closes #45

Test plan

  • grep -c "—" README.md docs/results.md docs/field-reverification.md → 0/0/0
  • grep -rn "—" → none
  • Verified load-bearing phrases and figures still present verbatim
  • Verified no leverage/robust/seamless/delve introduced
  • Project has no lint/markdown gate configured (per repo CLAUDE.md); not applicable here

🤖 Generated with Claude Code

…framing

Applies the two-part writing pass already used on jasoneplumb.com and the
profile README to README.md and docs/results.md. Em-dashes become commas,
colons, semicolons, or parentheses depending on the clause; the README
"## Evidence" heading becomes "## Results". docs/results.md keeps
punctuation-only changes since it is a cited source for the external
claims register. docs/field-reverification.md had no em-dashes and needed
no changes.

Refs #45

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jasoneplumb jasoneplumb added the review-requested Trigger Claude review label Sep 16, 2026
Comment thread README.md Outdated
| --- | --- |
| **Contribution** | Sole author: decision kernel and equivalence contract, replay harness, phone↔MCU shadow-comparison protocol, trace format, aggregation and ablation tooling, MCU ports. AI-assisted implementation gated by the tests, replay, and hardware-in-the-loop checks described below. Platform SDKs and map data are third-party. |
| **Status** | Working demonstrator on private hardware. Not a product, not a safety device, no users but the author. |
| **Evidence** | 23/23 traces replay exactly; 11,301 steps logged, 11,300 compared, 0 divergences across 8 instrumented rides, over a 23-trace/88.1 km/57,783-step corpus recorded 2026-07-20 to 2026-08-08. Re-verified 2026-09-12 against a tree identical to `dd8a7db25522734de1dbec614f66113c69d80dcb`. [Field results](docs/results.md) · [re-verification](docs/field-reverification.md) · [case study](https://www.jasoneplumb.com/case-studies/cue-equivalence-contract.html) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section heading was renamed from ## Evidence to ## Results (line 33), but this table row label | **Evidence** | was left unchanged. The deposition-style framing the PR set out to retire persists in the most prominent data row. Consider renaming to | **Field data** | or similar to match the new heading.

Comment thread docs/results.md Outdated
The same `kernel/cue_policy.c` runs in three places — live on the phone, as
the MCU actuator (Pico W, RFC 0006), and offline in the replay harness — and
The same `kernel/cue_policy.c` runs in three places: live on the phone, as
the MCU actuator (Pico W, RFC 0006), and offline in the replay harness, and

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The em-dash pair that cleanly delimited the three-item list has been replaced with a colon, but the closing clause "and the contract is" now reads as a potential fourth list member rather than the start of a new independent clause. The original em-dash pair was doing real structural work here. One fix: use a semicolon before "and the contract is" to clearly mark the clause boundary.

Suggested change
the MCU actuator (Pico W, RFC 0006), and offline in the replay harness, and
The same `kernel/cue_policy.c` runs in three places: live on the phone, as
the MCU actuator (Pico W, RFC 0006), and offline in the replay harness; and

Comment thread docs/results.md Outdated
| `too_late` | 7 | Drove the §13 `max_notice_s` 15 → 20 widening — which then failed and is on the record in `kernel/cue_policy.h` |
| `unrecognized` | 7 | A delivery/perceptibility outcome, not a policy one (see [grading-guide.md](grading-guide.md)) — moves no policy lever |
| `too_late` | 7 | Drove the §13 `max_notice_s` 15 → 20 widening, which then failed and is on the record in `kernel/cue_policy.h` |
| `unrecognized` | 7 | A delivery/perceptibility outcome, not a policy one (see [grading-guide.md](grading-guide.md)), moves no policy lever |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replacing the em-dash with a comma here creates a comma splice: "not a policy one (see …), moves no policy lever" joins two independent predicates with only a comma. The em-dash was doing structural work — it marked the transition to the key conclusion. A semicolon or a period would fix it.

Suggested change
| `unrecognized` | 7 | A delivery/perceptibility outcome, not a policy one (see [grading-guide.md](grading-guide.md)), moves no policy lever |
| `unrecognized` | 7 | A delivery/perceptibility outcome, not a policy one (see [grading-guide.md](grading-guide.md)); moves no policy lever |

@claude

claude Bot commented Sep 16, 2026

Copy link
Copy Markdown

🔍 Review verdict: 3 findings

Documentation-only PR replacing em-dashes with plain punctuation and renaming the ## Evidence heading to ## Results. No code changes; kernel constraints, NFR-003/004/005, and module boundaries are unaffected.

Findings

  1. README.md line 39 — incomplete rename (README.md): The section heading was updated to ## Results but the table row | **Evidence** | was left unchanged, keeping the deposition framing the PR aimed to retire.

  2. docs/results.md line 23–24 — structural ambiguity (docs/results.md): The em-dash pair that bracketed the three-item list was replaced by a colon, leaving "and the contract is" looking like a possible fourth list member rather than a new independent clause.

  3. docs/results.md line 54 — comma splice (docs/results.md): Replacing the em-dash with a comma in the unrecognized row joins two independent predicates with only a comma; a semicolon would fix it.

All three are prose-level issues; none affect correctness, kernel behaviour, or compliance with FR/NFR requirements.

…aries

Renames the README Evidence table row to Results to match the renamed
heading, and clarifies two clause boundaries in docs/results.md flagged
by review (semicolon before a following independent clause; semicolon
in the unrecognized-grade row) without changing any wording or figures.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jasoneplumb jasoneplumb added review-requested Trigger Claude review and removed review-requested Trigger Claude review labels Sep 16, 2026
@claude

claude Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

🔍 Review verdict: 0 findings

Incremental review covering changes since a6afd2b. The delta consists entirely of documentation edits:

  • README.md: Row label renamed from Evidence to Results (no content change).
  • docs/results.md: Two comma→semicolon punctuation fixes for grammatical clarity.

No code, kernel, replay, or logic changes. No NFR-003/NFR-004/NFR-005 concerns. Nothing to report.

@jasoneplumb
jasoneplumb merged commit 95353b4 into mainline Sep 16, 2026
6 checks passed
@jasoneplumb
jasoneplumb deleted the docs-voice-pass branch September 16, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-requested Trigger Claude review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace em-dashes and deposition framing in public docs

1 participant