Skip to content

docs: fix grpc endpoint examples#345

Open
compoodment wants to merge 1 commit into
xDarkicex:mainfrom
compoodment:fix/docs-valid-grpc-endpoint-examples
Open

docs: fix grpc endpoint examples#345
compoodment wants to merge 1 commit into
xDarkicex:mainfrom
compoodment:fix/docs-valid-grpc-endpoint-examples

Conversation

@compoodment

@compoodment compoodment commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replaces two invalid TLS configuration examples that used tcp:yourvector service.internal:50051.
  • Uses tcp:libravdb.internal:50051, which matches the documented tcp:<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 matches
  • git diff --check — pass

Docs-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:

  • Changed grpcEndpoint placeholder from tcp:yourvector service.internal:50051 to tcp:libravdb.internal:50051

Rationale

The previous placeholder contained a space in the hostname (yourvector service), which contradicts the documented tcp:<host>:<port> endpoint format and could cause confusion given that HTTP-style and unsupported endpoint schemes now fail fast with validation.

Impact

  • Documentation-only change — no code modifications, no runtime behavior changes
  • Lines changed: +2/-2
  • Complexity: No Big O notation or cyclomatic complexity implications (documentation only)

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 48a8eabb-accd-4ddc-8048-667777b169d4

📥 Commits

Reviewing files that changed from the base of the PR and between 96b7694 and 5b936b2.

📒 Files selected for processing (1)
  • docs/configuration.md

📝 Walkthrough

Walkthrough

This PR updates gRPC endpoint example hostnames in the configuration documentation, changing the placeholder from yourvector service.internal to libravdb.internal across two TLS configuration examples.

Changes

Configuration Documentation Update

Layer / File(s) Summary
gRPC endpoint example hostname updates
docs/configuration.md
Example JSON snippets for both CA-issued certificate and mTLS configurations are updated to use tcp:libravdb.internal:50051 instead of tcp:yourvector service.internal:50051.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📝 A rabbit hops through docs with care,
Two examples now match, fair and square,
From "yourvector" to "libravdb" so bright,
The configuration examples gleam just right! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix grpc endpoint examples' directly and accurately summarizes the main change: correcting placeholder hostnames in gRPC endpoint documentation examples.
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.

✏️ 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.

❤️ Share

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

@compoodment

Copy link
Copy Markdown
Collaborator Author

Vale Review

Verdict: no actionable findings.

This is a docs-only correction in docs/configuration.md: both TLS examples now use tcp:libravdb.internal:50051 instead of the invalid placeholder containing a space. That matches the documented tcp:<host>:<port> endpoint shape and avoids teaching users a malformed gRPC endpoint.

Verification:

gh pr diff 345 --repo xDarkicex/openclaw-memory-libravdb
gh pr checks 345 --repo xDarkicex/openclaw-memory-libravdb

CodeRabbit is passing. I did not run runtime tests because the PR changes documentation examples only.

– Vale

@compoodment compoodment left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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