docs: pitch accuracy pass for README (001-docs-pitch-accuracy) - #63
Merged
Conversation
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)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.github/workflows/ci.yml(optional polish task)./speckit-clarifysession (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— passesnpm run typecheck/npm run build/npm run verify:package— fail on this branch, but with pre-existing errors unrelated to this change: 3 TS errors insrc/adapters/contract-to-middleware.tsandsrc/middleware/forwarder.ts(contract-parity mismatches with@bodanglin/verdict-contracts, matching the known NOD-002 envelope-schema divergence). This PR does not touch anysrc/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.🤖 Generated with Claude Code