docs: sync documentation with current implementation#584
Open
avrabe wants to merge 1 commit into
Open
Conversation
Bring the prose docs in line with what the v0.18–v0.19 binary actually does. New capabilities were undocumented and several listings had drifted. New things documented: - `rivet sql` — a dedicated "SQL over the artifact store" section in docs/getting-started.md (table schema artifacts/links/fields/provenance, SELECT/WITH reads incl. the V-closure query, and the constrained `UPDATE artifacts SET status/title/description` write slice). Stresses it works with no server and no MCP. Also added to the embedded `rivet docs cli` topic under a new "Query Commands" block. - `rivet verify` — advance implemented -> verified on test evidence (incoming `verifies` link or `// rivet: verifies <ID>` marker); added to getting-started CLI commands and the embedded cli topic. - `rivet coverage` combined V-closure metric (intersection of every applicable rule); documented in getting-started CLI commands. - `rivet query` CLI command; documented in getting-started CLI commands. - `cited-source` is now a `common` base field usable on any artifact type; noted in the embedded schema-cited-sources topic. - `rivet init --vendor-schemas` and `rivet schema presets` / `schema sources` added to the embedded cli topic; presets list extended to the full set. Wrong/old things fixed: - README 30-second demo used a broken `rivet add` invocation (`rivet add requirement -t "..." --asil B` — `requirement` is not a positional, `-t` is `--type`, and there is no `--asil` flag). Corrected to `rivet add -t requirement --title "..."`. - README prebuilt-binary curl URL pinned to v0.16.1 -> v0.19.0. - export formats listed as only reqif/generic-yaml -> reqif, generic-yaml, html, zola, gherkin (getting-started + embedded cli topic). - MCP tool count 15 -> 16 (added `rivet_bundle`) in what-is-rivet, getting-started, and the embedded cli/mcp topics. Confirmed each documented command and query against the built binary; `rivet docs check` PASS (0 violations) and `rivet validate` PASS. Refs: REQ-229, REQ-230 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Brings the prose docs in line with what the v0.18–v0.19 binary actually does. Every claim below was verified against the built binary (
target/debug/rivet ... --help, liverivet sqlreads/writes,rivet mcp --list-tools).New things documented
docs/getting-started.mdrivet sql: the four projected tables (artifacts/links/fields/provenance),SELECT/WITHreads including the V-closure gap query, and the constrainedUPDATE artifacts SET status/title/descriptionwrite slice. Stresses it works with no server and no MCP.rivet coverage(incl. the combined V-closure metric),rivet verify(implemented → verified on test evidence),rivet query, andrivet sql.rivet-cli/src/docs.rs(embeddedrivet docs cli/schema-cited-sourcestopics)rivet queryandrivet sql(reads + the validated UPDATE write slice).rivet verifyadded to Project Commands.rivet init --vendor-schemas,rivet schema presets,rivet schema sourcesdocumented; preset list extended to the full set (do-178c, en-50128, iec-61508, iec-62304, iso-pas-8800, sotif).cited-sourceis now acommonbase field usable on any artifact type (verification artifacts included).Wrong/old things fixed
README.mdrivet addinvocation (rivet add requirement -t "..." --asil B) —requirementis not a positional,-tis--type, and there is no--asilflag. The command errors with "unexpected argument 'requirement'". Corrected torivet add -t requirement --title "...".docs/getting-started.mdreqif/generic-yaml→ nowreqif,generic-yaml,html,zola,gherkin(with the serve-feature gating note).rivet_bundle).docs/what-is-rivet.mdrivet_bundle).rivet-cli/src/docs.rsVerification
rivet docs check— PASS (0 violations).rivet validate— PASS (warnings are the pre-existing baseline).Flagged for human review
docs check --coverage(non-blocking, default mode) reports ~43 subcommands without a dedicatedrivet docs <slug>topic (a pre-existing backlog:trace,batch,supplier,sql,verify,bundle, …). Authoring per-subcommand topics for all of these was out of scope for this sync; flagging in case a follow-up wants to close that gap.cited-sourceschema-topic still describes remote backends (url/github/oslc/reqif/polarion) as "Phase 2 (planned)". I did not re-verify whether any of those shipped since; left as-is.Do not merge — left for human review.
🤖 Generated with Claude Code