Skip to content

docs(readme): formatting consistency, OVERT example version refresh, mcp_server cross-reference#106

Merged
vaaraio merged 1 commit into
mainfrom
docs/readme-cleanup
May 19, 2026
Merged

docs(readme): formatting consistency, OVERT example version refresh, mcp_server cross-reference#106
vaaraio merged 1 commit into
mainfrom
docs/readme-cleanup

Conversation

@vaaraio
Copy link
Copy Markdown
Owner

@vaaraio vaaraio commented May 19, 2026

Summary

Small README polish pass after the MCP proxy section landed in #105.

Changes

  1. Bullet formatting consistency. Framework integrations and Cloud guardrails bullets now use the period-after-bold style introduced in the MCP proxy section, so the four list styles in the README read uniformly.
  2. OVERT example version refresh. The OVERT 1.0 code example bumped from arbiter_version="vaara/0.15.0" to "vaara/0.21.0" to match the current shipped release.
  3. Cross-reference added in the Framework integrations MCP server bullet pointing to the new top-level MCP proxy section. Helps a scanner immediately see that vaara.integrations.mcp_server (Vaara as MCP server) is distinct from the MCP proxy (Vaara in front of an upstream MCP server).

Docs-only. No code changes, no test changes.

…mple version, cross-reference MCP server vs MCP proxy

Three small cleanups noticed in the README sweep after PR #105:

1. Em-dashes in seven bullet items (Framework integrations and Cloud guardrails) replaced with the period-after-bold style used in the new MCP proxy section.

2. OVERT 1.0 code example bumped from `arbiter_version="vaara/0.15.0"` to `"vaara/0.21.0"` to match the current shipped release.

3. The Framework integrations MCP server bullet now cross-references the top-level MCP proxy section, so a scanner reading the integrations list immediately sees that vaara.integrations.mcp_server (Vaara as MCP server) is distinct from the MCP proxy (Vaara in front of an upstream MCP server).
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

📝 Walkthrough

Walkthrough

This PR updates the Vaara README.md with documentation formatting refinements across framework integrations and guardrails adapter lists, plus a version reference bump in the OVERT 1.0 code example.

Changes

Documentation Updates

Layer / File(s) Summary
Framework integrations and guardrails adapters documentation
README.md
Reformatted bullet lists under "Framework integrations" (LangChain, CrewAI, OpenAI Agents SDK, MCP server) and "Cloud guardrails as upstream signals" (AWS Bedrock, Azure AI Content Safety, GCP Model Armor) with updated wording and punctuation.
OVERT 1.0 example version update
README.md
Updated arbiter_version parameter in OVERT 1.0 emit_base_envelope(...) code example from vaara/0.15.0 to vaara/0.21.0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • vaaraio/vaara#95: Previous README.md modifications to "Framework integrations" and "OVERT 1.0" sections with similar documentation scope.

Poem

🐰 Words rearranged with careful grace,
Adapters polished in their place,
Version bumped from old to new,
Documentation fresh and true!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main documentation changes: formatting consistency (em-dash removal), version refresh (OVERT example update), and MCP server cross-reference addition.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-cleanup

Warning

Review ran into problems

🔥 Problems

Stopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a @coderabbit review after the pipeline has finished.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@vaaraio vaaraio changed the title docs(readme): strip em-dashes, bump stale version, cross-reference mcp_server vs mcp_proxy docs(readme): formatting consistency, OVERT example version refresh, mcp_server cross-reference May 19, 2026
@vaaraio vaaraio merged commit cda4458 into main May 19, 2026
10 checks passed
@vaaraio vaaraio deleted the docs/readme-cleanup branch May 19, 2026 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant