docs: drop per-version README paragraphs, reorder for engineer-first reading#95
Merged
Merged
Conversation
…reading Per-version prose (v0.12 through v0.18) duplicated content already in CHANGELOG and the Releases page. The capabilities themselves stay as first-class README sections (HTTP API with curl example, TypeScript client with npm install and code block, OVERT 1.0 attestation with emit_base_envelope and verifier CLIs) so cold readers can still copy-paste from each. Install and Quick start now land before the evidence specimen. Where things live promoted to a table with CHANGELOG / SECURITY / CONTRIBUTING / signing-keys pointers added. 213 to 188 lines, no capabilities dropped.
📝 WalkthroughWalkthroughREADME.md documentation is reorganized to improve clarity and completeness: the evidence section is reflowed for compactness with updated install instructions, HTTP API documentation is rewritten to emphasize OpenAPI contracts and introduces a TypeScript client, and OVERT 1.0 attestation details are substantially expanded with operational and technical specifics. ChangesREADME documentation reorganization
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
125-126: ⚡ Quick winAdd a direct npm link for the TypeScript client package.
Line 125 says it ships as
@vaara/client; linking the package page (npm) here makes verification and onboarding faster than relying on name lookup.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 125 - 126, Update the README sentence that references clients/ts and the package name `@vaara/client` to include a direct npm package link (https://www.npmjs.com/package/@vaara/client) so readers can click through to the package page; edit the line that currently reads "ships on npm as `@vaara/client`" to embed that npm URL next to the package name.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 140: Replace the loose "overt.is" reference in the sentence beginning
"Vaara implements the OVERT 1.0 (overt.is) Protocol Profile 1.0 Base
Envelope..." with a direct canonical spec URL (the official OVERT 1.0
specification document/URI) and append a brief citation (e.g., spec title and
publication date) so the claim is verifiable; update the README sentence to
include the full spec link and citation in parentheses immediately after "OVERT
1.0" and keep the rest of the technical summary unchanged.
---
Nitpick comments:
In `@README.md`:
- Around line 125-126: Update the README sentence that references clients/ts and
the package name `@vaara/client` to include a direct npm package link
(https://www.npmjs.com/package/@vaara/client) so readers can click through to
the package page; edit the line that currently reads "ships on npm as
`@vaara/client`" to embed that npm URL next to the package name.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## OVERT 1.0 attestation | ||
|
|
||
| Vaara implements the OVERT 1.0 ([overt.is](https://overt.is/)) Protocol Profile 1.0 Base Envelope. OVERT 1.0 is an open standard for runtime trust in AI systems, authored by Glacis Technologies and published 25 March 2026. Closed-schema 9-field structure at AAL-3 Phase 2 (Provisional Receipt), canonical CBOR (RFC 8949), Ed25519 signatures, HMAC-SHA256 keyed commitments, IEEE-754 float rejection. v0.13.0 adds a reference Phase 3 IAP (`vaara.attestation.iap`) that notary-signs the Provisional Receipt and anchors it in a transparency log; production deployments can swap in sigstore Rekor or an equivalent independently-operated log at the same call sites. | ||
| Vaara implements the OVERT 1.0 ([overt.is](https://overt.is/)) Protocol Profile 1.0 Base Envelope. OVERT 1.0 is an open standard for runtime trust in AI systems, authored by Glacis Technologies and published 25 March 2026. Closed-schema 9-field structure at AAL-3 Phase 2 (Provisional Receipt), canonical CBOR (RFC 8949), Ed25519 signatures, HMAC-SHA256 keyed commitments, IEEE-754 float rejection. |
There was a problem hiding this comment.
Anchor the OVERT publication/date claim to a canonical spec URL.
Line 140 includes precise historical and technical claims; add a direct spec/document link (not only overt.is) so readers can verify details and avoid drift ambiguity.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 140, Replace the loose "overt.is" reference in the
sentence beginning "Vaara implements the OVERT 1.0 (overt.is) Protocol Profile
1.0 Base Envelope..." with a direct canonical spec URL (the official OVERT 1.0
specification document/URI) and append a brief citation (e.g., spec title and
publication date) so the claim is verifiable; update the README sentence to
include the full spec link and citation in parentheses immediately after "OVERT
1.0" and keep the rest of the technical summary unchanged.
vaaraio
added a commit
that referenced
this pull request
May 18, 2026
vaaraio
added a commit
that referenced
this pull request
May 18, 2026
… Rebuff) * feat: v0.20.0 OSS guardrail adapters (NeMo, Guardrails AI, LLM Guard, Rebuff) Four adapters mirror the v0.19.0 cloud pattern. 41 new mapping rows in _content_safety_articles.py across the four OSS providers (7 NeMo, 10 Guardrails AI, 20 LLM Guard, 4 Rebuff), tagged with EU AI Act articles and OWASP LLM Top 10 codes. 29 new tests, 712 total passing. Optional extras: nemo-guardrails, guardrails-ai, llm-guard, rebuff. HuggingFace Space added as Demo URL in pyproject and as a badge on README. TS client bumped lockstep to 0.20.0. * docs: drop version label from OSS guardrails section to align with #95 --------- Co-authored-by: vaaraio <267591518+vaaraio@users.noreply.github.com>
This was referenced May 19, 2026
docs(readme): formatting consistency, OVERT example version refresh, mcp_server cross-reference
#106
Merged
Merged
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
v0.12throughv0.18per-version paragraphs from README. CHANGELOG and Releases already carry the same history.### TypeScript clientsubsection), and OVERT 1.0 attestation as first-class sections with their install + code blocks. No capabilities lost in compression.Test plan
Summary by CodeRabbit