Skip to content

Lead with verification in the README - #26

Merged
Shakargy merged 1 commit into
mainfrom
readme-lead-with-verification
Aug 12, 2026
Merged

Lead with verification in the README#26
Shakargy merged 1 commit into
mainfrom
readme-lead-with-verification

Conversation

@Shakargy

Copy link
Copy Markdown
Owner

Why

The README still opened as a concept scanner (the v0.1 identity) while the sharpest thing DevTime does is now verification. Two concrete problems:

  1. The hero promised "helps a codebase explain itself from evidence" - vague to a first-time visitor.
  2. The 60-second path ended on dtc concepts, which returns 0-2 concepts on many real repos. dtc verify now returns a concrete finding on nearly any repo with routes, so we were leading people with the weaker command.

Changes

  • Hero: "DevTime verifies what your repository can actually prove", opening with the stripe/webhook.ts stub that looks like proof and isn't
  • Hero animation is now the verify lifecycle (SUPPORTED → CONTRADICTED → STALE); the scan tour moves down to illustrate the concept layer, so both demos earn their place
  • Quickstart ends with dtc verify, states what the demo repo actually returns, then points the reader at their own repo
  • Verify section moved above the fold with the five statuses and a real contradiction example; freshness and diff impact summarized
  • Capability list leads with verification and freshness
  • Dropped stale "V0" phrasing

Verification

Every output quoted in the README was captured from the published 0.5.0 package in a clean environment, not written by hand: billing SUPPORTED, JWT SUPPORTED, 2 of 3 routes have a referencing test.

Docs only. No code changes.

The README still opened as a concept scanner while the product's sharpest
capability is verification, and the 60-second path ended on `dtc concepts`,
which returns little on many real repositories. `dtc verify` now returns a
concrete finding on nearly any repo with routes, so it should be the first
thing a visitor runs and the first thing the page promises.

- Hero: "DevTime verifies what your repository can actually prove", opening on
  the stripe/webhook.ts stub that looks like proof and is not.
- Hero animation is now the verify lifecycle (SUPPORTED -> CONTRADICTED ->
  STALE); the scan tour moves down to illustrate the concept layer.
- Quickstart ends with `dtc verify` and shows what the demo repo actually
  returns, then points the reader at their own repository.
- Verify section moved above the fold with the five statuses and an example
  contradiction; freshness and diff impact summarized.
- Capability list leads with verification and freshness.

Docs only. Every output quoted was captured from the published 0.5.0 package.
@Shakargy
Shakargy merged commit 304c08b into main Aug 12, 2026
4 checks passed
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