Skip to content

docs: correct stale test counts and CLI/verification claims - #14

Merged
abienkowski merged 1 commit into
mainfrom
docs/readme-changelog-polish
Aug 18, 2026
Merged

docs: correct stale test counts and CLI/verification claims#14
abienkowski merged 1 commit into
mainfrom
docs/readme-changelog-polish

Conversation

@abienkowski

Copy link
Copy Markdown
Collaborator

Summary

Documentation polish for the first release (epic #4). Corrects stale counts and inaccurate claims found while auditing test parity and reproducible builds.

Changes

  • Test counts (README + CHANGELOG): update to actual values — Go 74, Rust 112, TypeScript 108 (were 58/104 and 88/80).
  • CLI flags (README): note --listen-socket is Go/Rust only (TypeScript listens on TCP via --listen-tcp), and clarify --docker-host is Unix-socket-only across all three (TS additionally rejects tcp:///http:// schemes). This is the credential boundary.
  • Formal verification (README): fix the make verify description (default evaluator, not Rust backend) and remove the unverifiable "2,400+ traces/sec" throughput claim; keep the accurate 10,000 sampled traces / 100 steps.

Verification / related issues

What was verified accurate (no change)

  • 9 invariants (6 P0 / 3 P1) across root README, spec/README.md, CHANGELOG, and the spec.
  • Middleware pipeline (7 gates/mutator), endpoint access table, and router paths match all three implementations.

- README/CHANGELOG: update unit test counts to actual (Go 74, Rust 112, TS 108)
- README: note --listen-socket is Go/Rust-only; TS is TCP-only, and
  --docker-host is Unix-socket-only across all three (TS rejects tcp/http)
- README: correct verify command (default evaluator, not Rust backend) and
  soften unverifiable throughput claim
@abienkowski abienkowski self-assigned this Aug 18, 2026
@abienkowski
abienkowski merged commit ef71339 into main Aug 18, 2026
6 checks passed
@abienkowski
abienkowski deleted the docs/readme-changelog-polish branch August 18, 2026 00:35
abienkowski added a commit that referenced this pull request Aug 18, 2026
The release-verify job ran `npm ci` at the repo root, where there is no
package-lock.json, so it failed with EUSAGE and blocked the entire release
pipeline (version/build/sign/publish jobs were skipped). Mirror the CI fix
from #14 by scoping npm ci to the ts/ working directory.
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.

CHANGELOG and README polish for first release

1 participant