docs(voyage): clarify API key setup#81803
Conversation
|
Codex review: needs maintainer review before merge. Workflow note: Future ClawSweeper reviews update this same comment in place. How this review workflow works
Summary Reproducibility: not applicable. as a runtime reproduction. The docs gap is source-verifiable on current main: the Voyage reference lacks setup steps while the memory config docs, plugin manifest, and doctor guidance define the credential path. PR rating Rank-up moves:
What the crustacean ranks mean
Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics. Real behavior proof Risk before merge
Maintainer options:
Next step before merge Security Review detailsBest possible solution: Land the docs clarification after normal docs review and current-head docs validation, without changing Voyage runtime credential resolution. Do we have a high-confidence way to reproduce the issue? Not applicable as a runtime reproduction. The docs gap is source-verifiable on current main: the Voyage reference lacks setup steps while the memory config docs, plugin manifest, and doctor guidance define the credential path. Is this the best way to solve the issue? Yes. Adding a short Setup section to the Voyage plugin reference is a narrow maintainable fix for the linked docs gap and avoids duplicating the full memory configuration reference. Label changes:
Label justifications:
Acceptance criteria:
What I checked:
Likely related people:
Codex review notes: model gpt-5.5, reasoning high; reviewed against 110042d840bb. |
This comment was marked as low quality.
This comment was marked as low quality.
444acb7 to
71ae125
Compare
|
@clawsweeper re-review requesting fresh review to understand current proof:sufficient state |
|
🦞🧹 I asked ClawSweeper to review this item again. Re-review progress:
|
|
ClawSweeper PR egg ✨ Hatched: 🥚 common Sunspot Test Hopper Hatch commandComment Hatchability rules:
Rarity: 🥚 common. What is this egg doing here?
|
|
Maintainer verification:
|
Summary
Fixes #81798.
Clarifies the Voyage plugin reference with the existing credential contract:
VOYAGE_API_KEYmodels.providers.voyage.apiKeyagents.defaults.memorySearch.provider: "voyage"setupopenclaw configure --section modelopenclaw memory status --deepReal behavior proof
Behavior or issue addressed: The public Voyage plugin reference now gives a direct setup path for the existing Voyage memory embedding credential contract instead of only saying that the plugin adds memory embedding provider support.
Real environment tested: Local OpenClaw checkout on Linux, branch
wolf/voyage-api-key-docs, commit444acb7a90.Exact steps or command run after this patch:
Evidence after fix: Terminal output from the docs checks:
Source-backed credential evidence checked in the same checkout:
Observed result after fix: The changed Voyage page renders as valid MDX and now contains the env var, config key, explicit memory search provider snippet, configure command, runtime verification command, and link to the full memory config reference.
What was not tested: No live Voyage API request was made because this PR changes documentation only and does not modify runtime credential resolution.