docs: v0.4.1 positioning — Evidence as Code frame#172
Merged
Conversation
Add docs/what-is-rivet.md as the canonical positioning doc: - Frame rivet as the audit substrate for AI-assisted engineering (not "SDLC traceability"). Contrast with Sphinx-Needs' "Engineering as Code": rivet is "Evidence as Code" — AI-authored, provenance-stamped, machine-validated, human-reviewed in PRs. - Document the per-situation playbook for 11 use-cases (TDD, ASPICE, STPA/ISO 26262, requirements, variant/PLE, LLM code review, provenance, cross-tool interop, GSN, tool qualification, spec-driven dev), each with question, artifacts, AI role, human role, and explicit limits. - Make the human-vs-AI split explicit in a table. - Document what rivet is NOT (no Polarion live editing, no direct ALM connector today, no iso-26262.yaml schema yet, no npm distribution yet — all marked "planned for v0.5.0"). - Quick-start with today's install path (cargo) plus the planned npm path for v0.5.0. Rewrite README.md intro (top ~30 lines) to align with the frame — replacing the feature-list first paragraph with an evidence-centric one-paragraph pitch that points at docs/what-is-rivet.md for depth. All capability claims are verifiable against main HEAD: 34 hazards + 62 UCAs + 62 controller constraints in safety/stpa/, the MCP tool list (rivet_list/get/query/add/modify/link/unlink/remove/validate/ coverage/stats/schema/embed/snapshot_capture/reload) matches rivet-cli/src/mcp.rs, and the s-expr predicates (forall/exists/reachable-from/reachable-to) match rivet-core/src/sexpr_eval.rs. Refs: FEAT-001 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rewrites docs/what-is-rivet.md and the README intro to match the rivet-v0-1-0 blog post cadence: Problem → Answer → Evidence, concrete numbers per section, no marketing vocabulary, three-sentence README intro (problem / answer / concrete result). All facts from 3b89365 preserved. Honesty flags for planned-for-v0.5.0 items kept. Use-case palette kept; human-vs-AI table tightened. Refs: FEAT-001
7bd7377 to
7812ece
Compare
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'Rivet Criterion Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.
| Benchmark suite | Current: 7812ece | Previous: 61bfc41 | Ratio |
|---|---|---|---|
store_lookup/100 |
2243 ns/iter (± 8) |
1677 ns/iter (± 3) |
1.34 |
store_lookup/1000 |
24913 ns/iter (± 182) |
19262 ns/iter (± 54) |
1.29 |
traceability_matrix/1000 |
60215 ns/iter (± 161) |
40570 ns/iter (± 154) |
1.48 |
query/100 |
820 ns/iter (± 2) |
646 ns/iter (± 2) |
1.27 |
query/1000 |
7511 ns/iter (± 28) |
5450 ns/iter (± 12) |
1.38 |
This comment was automatically generated by workflow using github-action-benchmark.
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.
Summary
docs/what-is-rivet.md— the canonical positioning doc (~2000 words). Frames rivet as the audit substrate for AI-assisted engineering ("Evidence as Code"), contrasts with Sphinx-Needs' "Engineering as Code", and gives a per-situation playbook for 11 use-cases (TDD, ASPICE, STPA/ISO 26262, requirements, variant/PLE, LLM code review, provenance, cross-tool interop, GSN, tool qualification, spec-driven dev). Each use-case is ~100 words with question / artifacts / AI role / human role / explicit limits.README.md— replaces the "SDLC traceability for safety-critical systems" + feature-list first paragraph with an evidence-centric pitch that points atdocs/what-is-rivet.mdfor depth. The rest of the README (features, quick start, CLI table, architecture, dogfooding, dev) is untouched.iso-26262.yamlschema yet, no npm distribution yet. All in-flight items are marked "planned for v0.5.0".All capability claims are verifiable against
mainHEAD:safety/stpa/)rivet-cli/src/mcp.rs(rivet_list/get/query/add/modify/link/unlink/remove/validate/coverage/stats/schema/embed/snapshot_capture/reload)forall/exists/reachable-from/reachable-tomatchrivet-core/src/sexpr_eval.rsrivet-core/src/proofs.rstests/playwright/iso-pas-8800,iec-61508,iec-62304,do-178c,en-50128,eu-ai-act,safety-case,aspice,stpa,stpa-sec) all exist inschemas/Chosen one-sentence pitch: "rivet is the audit substrate for AI-assisted engineering — every artifact, link, and decision carries evidence a human can review in a pull request."
Alternates considered:
Trailer:
Refs: FEAT-001.Test plan
rivet validatestill PASS (docs changes only; no schema/source changes)docs/what-is-rivet.mdresolve — especiallydesign/polarion-reqif-fidelity.md,getting-started.md,architecture.md,schemas.md,stpa-sec.md,verification.md,roadmap.md,audit-report.mdREADME.mdrenders cleanly on GitHub (no broken reference badge or link)🤖 Generated with Claude Code