feat(v0.5.0): README rewrite + rivet quickstart + CHANGELOG#227
Merged
Conversation
Three coordinated deliverables for the v0.5.0 release. 1. README rewritten around the three-pillar synthesis (typed knowledge graph + oracle-gated agents + agent-first form factor) instead of a feature list. Leads with why-rivet, install, the 30-second demo, then pointers to the embedded docs and the agent-facing surfaces (MCP, LSP, Mythos slop-hunt, agent pipelines). Honest "in flight" section flags variant tooling open questions and formal-method gaps. 2. New `rivet quickstart` subcommand prints a 10-step oracle-gated walk-through. Each step has a deterministic oracle command + expected output so an AI agent can follow the doc autonomously. Embedded as `rivet-cli/src/quickstart.md` via `include_str!`, listed under a new "Getting started" category in `rivet docs`. `rivet quickstart` is an ergonomic alias for `rivet docs quickstart`. 3. CHANGELOG entry for 0.5.0 covers the merged PRs from the day: #205 Mythos slop-hunt + agent-pipelines foundation, #208 CoverageStore witness consumer, #210 Rocq full restoration, #212 Verus full restoration, #213 serve middleware status preservation, #211/#215/#217/#220 Playwright green + 10 rendering invariants, #218/#221 16-shard mutation testing + ~64 mutant-killing tests, #223 variant scoping for 8 dashboard handlers, #224 docs warn-or-allowlist. Workspace, vscode-rivet, and npm root package versions bumped to 0.5.0. Platform packages stay on the release-npm.yml override path. Verified: cargo check, cargo clippy --workspace -- -D warnings, cargo test -p rivet-cli (99 unit + 200+ integration tests pass), rivet docs check PASS, rivet docs quickstart prints the walk-through. Implements: REQ-007 Refs: FEAT-001 Trace: skip
📐 Rivet artifact deltaNo artifact changes in this PR. Code-only changes (renderer, CLI wiring, tests) don't touch the artifact graph. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
Summary
Three coordinated deliverables that unblock the v0.5.0 release:
oracle-gated agents + agent-first form factor) instead of a feature
list. One-line tagline, why-rivet (citing the
three-patterns-colliding
blog), install, 30-second demo, what-is-here, agent-facing surfaces,
honest in-flight status (variant open questions, formal-method gaps).
Skimmable in 60 seconds.
rivet quickstartsubcommand that prints a 10-step oracle-gatedwalk-through. Every step has a deterministic oracle command + expected
output so an AI agent can follow the doc autonomously. Embedded as
rivet-cli/src/quickstart.mdviainclude_str!, listed under a new"Getting started" category in
rivet docs.rivet quickstartis theergonomic alias for
rivet docs quickstart.agent-pipelines), feat(rivet-core): CoverageStore for external coverage evidence (witness consumer) #208 (CoverageStore witness consumer), fix(proofs): restore Validation.v import + replace Admitted with proofs #210 (Rocq
full restoration), fix(verus): correct vstd lemma paths + matches!→is + lemma_div_multiples_vanish #212 (Verus full restoration), fix(serve): preserve response status through wrap_full_page middleware #213 (serve
middleware status preservation), fix(tests/playwright): batch stale-test cleanups (5 of 10) #211/feat(tests/playwright): rendering invariant coverage — 10 new tests #215/fix(playwright): close out remaining 8 dashboard test failures #217/test(playwright): flip description-mermaid pin to expect .svg-viewer wrap #220 (Playwright green
mutant-killing tests), feat(serve): variant scoping for 8 handlers (close incoherence flagged in PR #215) #223 (variant scoping for 8 dashboard
handlers), feat(docs): warn-or-allowlist for non-rivet files in scanned dirs (Task #56) #224 (docs warn-or-allowlist).
Workspace,
vscode-rivet, and npm root package versions bumped to0.5.0. Platform packages stay on therelease-npm.ymloverride path.Test plan
cargo check --workspacecargo clippy --workspace --all-targets -- -D warningscargo fmt --all -- --checkcargo test -p rivet-cli(99 unit + 200+ integration tests pass)rivet docs checkPASSrivet quickstartprints the 10-step walk-throughrivet docslistsquickstartunder "Getting started"rivet --versionreports0.5.0v0.5.0to triggerrelease.ymlandrelease-npm.yml(out of scope for this PR)🤖 Generated with Claude Code