Skip to content

PR-09: README truth pass (scanner) - #38

Merged
emmanuelgjr merged 1 commit into
mainfrom
improve/pr-09-readme-truth
Jul 18, 2026
Merged

PR-09: README truth pass (scanner)#38
emmanuelgjr merged 1 commit into
mainfrom
improve/pr-09-readme-truth

Conversation

@emmanuelgjr

Copy link
Copy Markdown
Contributor

Phase 2. Makes every README claim match the new reality. Depends on PR-07.

  • Architecture: intro explains deterministic CLI (owns matching, reproducible) + skill (orchestrates); two engine modes.
  • Honest-language pass: every "safe to share/commit/store" → "designed to minimize disclosure" + residual-risk. The Phase-2 overclaim gate now passes repo-wide.
  • Cost & runtime section ($0 CLI-only; ~1–3 min skill mode on the fixture; fork-PR behavior; --diff marked v0.4).
  • Contributing quick-start box linking the FP/FN templates; version badge → v0.3; Quick Start shows the CLI option + timestamped report path.

Verification: md-links resolve; overclaim gate clean; scanner-lint green.

PNG note: an authentic fixture screenshot needs the HTML rendering that lands with PR-14's template; the interim compressed image is kept and its caption says it'll be regenerated then (matches the plan).

- Reflect the v0.3 architecture: deterministic CLI owns matching, skill
  orchestrates; two engine modes; SARIF/Code Scanning; timestamped reports;
  file-ID strict mode.
- Honest-language pass: every 'safe to share/commit/store' overclaim replaced
  with 'designed to minimize disclosure' + residual-risk. The Phase-2 overclaim
  gate now passes repo-wide.
- Add a Cost & runtime section ($0 CLI-only mode; skill mode ~1-3 min on the
  fixture; fork-PR behavior; --diff marked v0.4) and a Contributing quick-start
  ('found a wrong result? that's a contribution') linking the FP/FN templates.
- Skill version badge -> v0.3; Quick Start shows the CLI option and the
  timestamped report path.

PNG note: an authentic fixture-generated screenshot requires the HTML report
rendering that lands with PR-14's deterministic template; the interim compressed
image is kept and the caption says so. This matches the plan, which regenerates
the PNG in PR-14.
@emmanuelgjr
emmanuelgjr merged commit 0a3b6b8 into main Jul 18, 2026
8 checks passed
@emmanuelgjr
emmanuelgjr deleted the improve/pr-09-readme-truth branch July 18, 2026 06:31
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