Skip to content

docs: strengthen enterprise proof quality#294

Merged
BenSheridanEdwards merged 4 commits into
mainfrom
docs/enterprise-readme
Jul 18, 2026
Merged

docs: strengthen enterprise proof quality#294
BenSheridanEdwards merged 4 commits into
mainfrom
docs/enterprise-readme

Conversation

@BenSheridanEdwards

@BenSheridanEdwards BenSheridanEdwards commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Why does this feature exist?

Enterprise evaluators need to understand StyleProof's value before they invest time in setup. The previous README buried the strongest evidence, and the first replacement "clean" screenshot looked green while its underlying report contained caveats that contradicted that claim. The repository also needed a durable rule preventing that class of evidence-quality failure from recurring.

What changed?

  • Reframed the README opening around the enterprise review problem and the trust model StyleProof provides.
  • Added four real, privacy-clean screenshots showing the blocked check, certified-clean check, report overview, and an annotated before/after diff.
  • Rejected the original dogfood "clean" screenshot after auditing its warnings; it did not assert coverage or determinism and showed an unacknowledged inventory removal.
  • Added a committed certified-clean report generated from two real Chromium captures with an explicit surface registry, self-check determinism, inventory capture, and data-residue gating.
  • Linked each check state and report image to its public source so the evidence is inspectable rather than illustrative.
  • Reconciled the walkthrough with the current demo fixture (button.cta, blue #2563eb to red #dc2626).
  • Added a mandatory semantic evidence audit to AGENTS.md, .agents/project/PR_QUALITY.md, and .agents/project/DEFINITION_OF_DONE.md.
  • The audit requires every visible warning and caveat to agree with the claim, final rendered inspection at reviewer size, and live exact-head verification after the last change.
  • Configuration, dependencies, runtime behaviour, and the public API are unchanged.

Behavioural Proof (with video and screenshots)

  • Video: Not applicable — this is a static README and policy-document change with no motion or timing behaviour.

  • Screenshots:

    Blocked check state

    StyleProof blocked check state

    Certified-clean report — every trust gate is green

    StyleProof clean check state

    Current report overview

    StyleProof report overview

    Current annotated before and after diff

    StyleProof annotated report diff

  • Capture proof: the dedicated base/head Chromium capture passed 8/8 coverage and capture checks.

  • Branch proof: 114 browser E2E scenarios passed after the certified screenshot correction. The final commit changes policy Markdown only, so browser E2E was not rerun; no runtime, capture, report, or Action behaviour changed.

Verification Summary

  • Definition of Done: followed .agents/project/DEFINITION_OF_DONE.md.
  • Commands run after the final policy/docs change:
    • npm run build
    • npm run typecheck
    • npm run lint
    • npm run format:check
    • npm run privacy:check
    • npm test
    • npm run demo:check
    • npm audit --audit-level=high
    • git diff --check
  • Results: all applicable gates passed; 543 unit tests passed; privacy scan covered 162 public text files; demo report is current; dependency audit found 0 vulnerabilities. Lint reports 0 errors and retains one pre-existing no-console warning in src/runner.ts.
  • Skipped checks: npm run test:e2e was not rerun after the final policy-only commit because browser/runtime behaviour is unchanged; risk is limited to Markdown policy wording and the owner is this PR. npm pack is not applicable because the package payload is unchanged.

Checklist

  • Embedded committed, authentic screenshots and confirmed docs/demo/report.md is current
  • Semantically audited every visible warning, caveat, badge, caption, label, and status detail
  • Capture/diff/report rendering is unchanged; npm run demo:check passed
  • npm run build && npm run typecheck && npm run lint && npm run format:check pass
  • npm test passes with 543 tests
  • Browser E2E passed for the screenshot correction; final policy-only commit has a documented technical exclusion
  • README and durable repository quality contracts are updated; CHANGELOG is not applicable because behaviour and public API are unchanged
  • Followed .agents/project/DEFINITION_OF_DONE.md, .agents/skills/pr-quality-contract/SKILL.md, and .agents/skills/pr-inline-screenshot-proof/SKILL.md
  • Screenshots are committed and embedded inline with ![alt](...png?raw=1)
  • The PR body has no bare screenshot links, local paths, relative paths, or proof placeholders

@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown

🗺️ StyleProof report

📊 View the side-by-side visual report →


A navigable affordance was removed without acknowledgement — repair or acknowledge it; visual approval cannot clear this failure.

@BenSheridanEdwards BenSheridanEdwards changed the title docs(readme): lead with enterprise proof docs: strengthen enterprise proof quality Jul 18, 2026
@BenSheridanEdwards
BenSheridanEdwards merged commit 1953437 into main Jul 18, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant