Skip to content

docs: plain-language README, fresh screenshots, social preview image - #4

Open
AlfredBateman wants to merge 2 commits into
mainfrom
docs/readme-refresh
Open

AlfredBateman wants to merge 2 commits into
mainfrom
docs/readme-refresh

Conversation

@AlfredBateman

Copy link
Copy Markdown
Owner

Rewrites the README for readers who have not met statistical testing, and regenerates every README screenshot from a local stack at the current UI.

  • README: What is this / Why use it / How it works in four steps, the three quick-start paths, the Action snippet at v0.1.0, measured results copied from docs/metrics.md and CI, and the limitations. No live-demo link (it will be added separately).
  • Screenshots: landing, project overview, a live run at 51 of 180 attempts, a finished run with the regression verdict, the trace viewer, the compare view, and one 390 px shot. The old readme-* files are replaced or removed.
  • docs/metrics.md: the CI section now reads from the latest green run on main (1,161 + 12 Python tests, 353 web unit tests, 46 end-to-end tests, 97% coverage for core and api, median CI 8 min 19 s).
  • docs/social-preview.png: 1280x640, 203 KB, captured from the landing hero.

The Docker compose path is checked by CI only; it was not run locally.

Rewrite the README for readers new to statistical testing and regenerate
every screenshot from the local stack at the current UI. Update the CI
figures in metrics.md to the latest green run on main. Add a 1280x640
social preview image.
@vercel

vercel Bot commented Oct 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
agent-probe Skipped Skipped Oct 16, 2026 6:03pm UTC

This branch was previously deployed

1 inactive deployment
Preview — 0abf0a07 Deployed Oct 16, 2026 by vercel[bot]
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