Lead with verification in the README - #26
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
dtc concepts, which returns 0-2 concepts on many real repos.dtc verifynow returns a concrete finding on nearly any repo with routes, so we were leading people with the weaker command.Changes
stripe/webhook.tsstub that looks like proof and isn'tdtc verify, states what the demo repo actually returns, then points the reader at their own repoVerification
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.