docs: fix grpc endpoint examples#345
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates gRPC endpoint example hostnames in the configuration documentation, changing the placeholder from ChangesConfiguration Documentation Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
Vale ReviewVerdict: no actionable findings. This is a docs-only correction in Verification: CodeRabbit is passing. I did not run runtime tests because the PR changes documentation examples only. – Vale |
compoodment
left a comment
There was a problem hiding this comment.
Vale Review
Quality: Q2/5 — smoke
Name: Docs: fix gRPC endpoint examples
Evidence: Two placeholder hostnames in docs/configuration.md changed from tcp:yourvector service.internal:50051 (space in hostname — invalid per the tcp:<host>:<port> format) to tcp:libravdb.internal:50051.
Assessment: Correct and narrow docs fix. The old placeholder was invalid and confusing, especially after PR #343 added endpoint scheme validation. No behavioral change.
Why Q2: Docs-only fix with no runtime impact. Useful but not action-worthy beyond a quick approve. Already correct.
– Vale
Summary
tcp:yourvector service.internal:50051.tcp:libravdb.internal:50051, which matches the documentedtcp:<host>:<port>endpoint shape.Motivation
The old placeholder included a space in the host name. That contradicts the endpoint format documented elsewhere and becomes especially confusing now that HTTP-style and unsupported endpoint schemes fail fast.
Verification
grep -RIn "yourvector service" docs README.md openclaw.plugin.json src test || true— no remaining matchesgit diff --check— passDocs-only change; no runtime tests run.
Documentation Fix: gRPC Endpoint Examples
This pull request corrects invalid placeholder values in gRPC TLS configuration examples in
docs/configuration.md.Changes
Two JSON configuration examples in the "Remote vector service with CA-issued cert" and "Remote vector service with mTLS" sections have been updated:
grpcEndpointplaceholder fromtcp:yourvector service.internal:50051totcp:libravdb.internal:50051Rationale
The previous placeholder contained a space in the hostname (
yourvector service), which contradicts the documentedtcp:<host>:<port>endpoint format and could cause confusion given that HTTP-style and unsupported endpoint schemes now fail fast with validation.Impact