Skip to content

docs: a README that says what Sigil does, how a proof works, and where it stands - #22

Merged
dgesteves merged 1 commit into
mainfrom
docs/readme
Nov 2, 2026
Merged

dgesteves merged 1 commit into
mainfrom
docs/readme

Conversation

@dgesteves

Copy link
Copy Markdown
Owner

The README was a 12-line "under construction" stub. This replaces it with the front door: the problem, what Sigil does, a quick start, how a proof works, trust levels, an honest status and the repo layout.

How it was written:

  • Every number checked against its source today. SkillsBench's abstract has been revised since we first read it: +16.6 points on average (33.9% to 50.5%), ranging from +4.1 to +25.7 across 18 model-harness setups. SWE-Skills-Bench: 92 of 98 skills had no statistically significant effect (76.6% to 76.9%). Scan numbers come from packages/sigil/src/scan/BENCHMARK.md (47 benign skills with zero high or critical findings, all 14 malicious samples flagged). Agent counts come from core/ids.ts (22 agents plus generic).
  • Only commands that exist, with their real flags. Sigil isn't on npm yet, so the quick start runs from a clone and says so.
  • Honest status: all capabilities are submitted and untested, the first local lab runs hit ceiling effects, and no number is published until a run produced it. The header image is the site's OG image, rendered from the live registry, so it can't drift.
  • No named-competitor comparison table. The claims about other tools can't be re-verified today, so they stay out.

Also corrects spec/METHODOLOGY.md, which said evidence "are published with GitHub artifact attestations" in the present tense. The CI proving workflow isn't live yet, so it now says CI-produced evidence is attested and local runs are labelled local until then.

The catalog line lists what is on main at this commit. When #17 and #19 land, it gains Next.js, Svelte, Vue, Angular and OAuth.

…e it stands

Also corrects METHODOLOGY: evidence is attested when produced in CI, and
the CI proving workflow is not live yet.
@vercel

vercel Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

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

1 Skipped Deployment
Project Deployment Actions Updated
sigil-lab Ignored Ignored Preview Nov 2, 2026 9:15am UTC

@dgesteves
dgesteves merged commit 8421cc7 into main Nov 2, 2026
8 checks passed
@dgesteves
dgesteves deleted the docs/readme branch November 2, 2026 09:23
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