Skip to content

docs: pitch accuracy pass for README (001-docs-pitch-accuracy) - #63

Merged
mrnicholasbcarter-code merged 2 commits into
masterfrom
feat/001-docs-pitch-accuracy
Sep 5, 2026
Merged

docs: pitch accuracy pass for README (001-docs-pitch-accuracy)#63
mrnicholasbcarter-code merged 2 commits into
masterfrom
feat/001-docs-pitch-accuracy

Conversation

@mrnicholasbcarter-code

Copy link
Copy Markdown
Owner

Summary

  • Rewrites the README opening tagline and "What is" paragraphs in plain language, explicitly stating Verdict Core decides, verdict-node enforces at the HTTP edge, while preserving the existing "still being reconciled" envelope-contract disclosure, the Next.js fail-open critical-limitation warning, and the Alpha status label verbatim (FR-002, FR-004).
  • Hedges the OmniRoute ecosystem-table entry as an unverified third-party claim rather than an unqualified fact (FR-006).
  • Adds a CI status badge for .github/workflows/ci.yml (optional polish task).
  • Adds the spec-kit artifacts for this feature (spec/plan/tasks/research/quickstart/checklist) as their own preserved commit, including the completed /speckit-clarify session (2026-09-05: full ambiguity-taxonomy scan run, no critical ambiguities found).

No src/ files were touched. T010 (createNextApiHandler fail-open code defect) is explicitly out of scope for this docs feature per spec.md FR-009/FR-010 — it is tracked separately as pre-existing issue #51, correctly scoped there as a code-fix-only issue that must not be silently fixed as a side effect of this PR, and the README's existing disclosure of that defect (lines ~99, ~112, ~160) is left untouched and undiminished.

Refs #51 #52 #53 #54 #55 #56 #57 #58 #59 #60 #61 #62

Test plan

  • npm run format:check — passes (prettier applied to README.md; re-verified no protected content changed)
  • npm run pack:dry-run — passes
  • npm run typecheck / npm run build / npm run verify:packagefail on this branch, but with pre-existing errors unrelated to this change: 3 TS errors in src/adapters/contract-to-middleware.ts and src/middleware/forwarder.ts (contract-parity mismatches with @bodanglin/verdict-contracts, matching the known NOD-002 envelope-schema divergence). This PR does not touch any src/ file.
  • npm test — 2 of 4 suites fail (tests/contract-parity.test.ts, tests/middleware/forwarder.test.ts) — same pre-existing contract-parity issue, unrelated to this docs-only change; the other 2 suites (216 total tests, 198 passing) are unaffected.
  • Manual diff review: every README hunk traced back to a spec FR; protected regions (badges, Next.js fail-open warning, reconciliation statement, Alpha label, verdict-core/verdict-cockpit ecosystem rows) confirmed byte-identical via grep/diff before and after.

🤖 Generated with Claude Code

Nicholas Carter added 2 commits September 5, 2026 22:41
Preserve the spec, plan, tasks, research, quickstart, and requirements
checklist for the documentation & pitch accuracy feature on its own
branch, including the completed /speckit-clarify session (no critical
ambiguities found).
…007,T009)

- T003: Rewrite opening tagline and "What is" paragraphs in plain
  language, stating explicitly that Verdict Core decides and
  verdict-node enforces at the HTTP edge (FR-002). Explain
  ExecutionEnvelope/fail-closed inline; preserve the "still being
  reconciled" cross-language contract disclosure verbatim in substance
  (FR-004). Next.js fail-open disclosure, Alpha status label, and
  badge row are untouched (verified via diff/grep).
- T007: Hedge the OmniRoute ecosystem-table claim as a third-party,
  unverified description rather than an unqualified fact (FR-006).
- T009: Add a CI status badge for .github/workflows/ci.yml.

Refs: #52 #53 #54 #58 (T003), #56 (T007), #60 (T009)
@mrnicholasbcarter-code
mrnicholasbcarter-code merged commit 92847a5 into master Sep 5, 2026
7 checks passed
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