Skip to content

docs(voyage): clarify API key setup#81803

Merged
steipete merged 1 commit into
openclaw:mainfrom
luoyanglang:wolf/voyage-api-key-docs
May 22, 2026
Merged

docs(voyage): clarify API key setup#81803
steipete merged 1 commit into
openclaw:mainfrom
luoyanglang:wolf/voyage-api-key-docs

Conversation

@luoyanglang

@luoyanglang luoyanglang commented May 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes #81798.

Clarifies the Voyage plugin reference with the existing credential contract:

  • VOYAGE_API_KEY
  • models.providers.voyage.apiKey
  • explicit agents.defaults.memorySearch.provider: "voyage" setup
  • openclaw configure --section model
  • openclaw memory status --deep
  • link to the memory config API key matrix

Real 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, commit 444acb7a90.

Exact steps or command run after this patch:

node scripts/docs-list.js
node scripts/check-docs-mdx.mjs docs README.md
git diff --check

Evidence after fix: Terminal output from the docs checks:

node scripts/docs-list.js
Listing all markdown files in docs folder:
...
plugins/reference/voyage.md - Adds memory embedding provider support.
...

node scripts/check-docs-mdx.mjs docs README.md
Docs MDX check passed (640 files, 15891ms).

git diff --check
<no output>

Source-backed credential evidence checked in the same checkout:

docs/reference/memory-config.md:
Voyage | VOYAGE_API_KEY | models.providers.voyage.apiKey

extensions/voyage/openclaw.plugin.json:
"providerAuthEnvVars": {
  "voyage": ["VOYAGE_API_KEY"]
}

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.

@openclaw-barnacle openclaw-barnacle Bot added docs Improvements or additions to documentation size: XS triage: needs-real-behavior-proof Candidate: external PR needs after-fix proof from a real setup. labels May 14, 2026
@clawsweeper

clawsweeper Bot commented May 14, 2026

Copy link
Copy Markdown
Contributor

Codex review: needs maintainer review before merge.

Workflow note: Future ClawSweeper reviews update this same comment in place.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

Summary
Adds a Voyage plugin Setup section documenting VOYAGE_API_KEY, models.providers.voyage.apiKey, explicit memory-search provider config, setup/status commands, and a memory config reference link.

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
Overall: 🐚 platinum hermit
Proof: 🌊 off-meta tidepool
Patch quality: 🐚 platinum hermit
Summary: Focused docs-only PR with no blocking findings and source-aligned content; merge confidence mainly depends on current-head docs validation.

Rank-up moves:

  • none
What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

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
Not applicable: Real behavior proof is not required because this PR only changes files under docs/.

Risk before merge

  • Docs validation was not rerun locally against the PR head during this read-only sweep; maintainers should rely on current-head CI or a fresh docs check before merge.

Maintainer options:

  1. Decide the mitigation before merge
    Land the docs clarification after normal docs review and current-head docs validation, without changing Voyage runtime credential resolution.
  2. Pause or close
    Do not merge this PR until maintainers decide whether the risk is worth taking.

Next step before merge
No repair lane is needed; the remaining action is normal docs maintainer review, current-head docs validation, and merge if accepted.

Security
Cleared: Docs-only change; no code execution, dependency, workflow, secret value, or supply-chain surface is introduced.

Review details

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

  • add rating: 🐚 platinum hermit: Current PR rating is 🐚 platinum hermit because proof is 🌊 off-meta tidepool, patch quality is 🐚 platinum hermit, and Focused docs-only PR with no blocking findings and source-aligned content; merge confidence mainly depends on current-head docs validation.
  • add status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Not applicable: Real behavior proof is not required because this PR only changes files under docs/.
  • remove impact:auth-provider: Current review selected no impact labels.

Label justifications:

  • P3: This is a low-risk docs-only clarification for an existing provider setup path.
  • rating: 🐚 platinum hermit: Current PR rating is 🐚 platinum hermit because proof is 🌊 off-meta tidepool, patch quality is 🐚 platinum hermit, and Focused docs-only PR with no blocking findings and source-aligned content; merge confidence mainly depends on current-head docs validation.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Not applicable: Real behavior proof is not required because this PR only changes files under docs/.

Acceptance criteria:

  • node scripts/docs-list.js
  • node scripts/check-docs-mdx.mjs docs README.md
  • git diff --check

What I checked:

Likely related people:

  • Ayaan Zaidi: Current checkout blame and log for the Voyage reference, memory config reference, Voyage manifest, and memory doctor guidance point to this contributor on the relevant current-main lines. (role: recent area contributor; confidence: medium; commits: ac28341ebfcc; files: docs/plugins/reference/voyage.md, docs/reference/memory-config.md, extensions/voyage/openclaw.plugin.json)
  • stielemans: The PR discussion includes a merge-gate pass from this reviewer for the same docs-only surface, making them a useful routing contact for the current review state. (role: recent reviewer; confidence: medium; files: docs/plugins/reference/voyage.md)

Codex review notes: model gpt-5.5, reasoning high; reviewed against 110042d840bb.

@clawsweeper clawsweeper Bot added the proof: sufficient ClawSweeper judged the real behavior proof convincing. label May 14, 2026
@openclaw-barnacle openclaw-barnacle Bot added proof: supplied External PR includes structured after-fix real behavior proof. and removed proof: sufficient ClawSweeper judged the real behavior proof convincing. triage: needs-real-behavior-proof Candidate: external PR needs after-fix proof from a real setup. labels May 14, 2026
@clawsweeper clawsweeper Bot added the proof: sufficient ClawSweeper judged the real behavior proof convincing. label May 14, 2026
@stielemans

This comment was marked as low quality.

@luoyanglang luoyanglang force-pushed the wolf/voyage-api-key-docs branch from 444acb7 to 71ae125 Compare May 17, 2026 11:08
@openclaw-barnacle openclaw-barnacle Bot removed the proof: sufficient ClawSweeper judged the real behavior proof convincing. label May 17, 2026
@clawsweeper clawsweeper Bot added P3 Low-priority cleanup, docs, polish, ergonomics, or speculative work. impact:auth-provider Auth, provider routing, model choice, or SecretRef resolution may break. labels May 17, 2026
@luoyanglang

Copy link
Copy Markdown
Contributor Author

@clawsweeper re-review

requesting fresh review to understand current proof:sufficient state

@clawsweeper

clawsweeper Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

🦞🧹
ClawSweeper re-review requested.

I asked ClawSweeper to review this item again.
Action: item re-review queued (workflow sweep.yml, event repository_dispatch).
Result: the existing ClawSweeper review comment will be edited in place when the review finishes.

Re-review progress:

@clawsweeper clawsweeper Bot added rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. and removed impact:auth-provider Auth, provider routing, model choice, or SecretRef resolution may break. labels May 20, 2026
@clawsweeper

clawsweeper Bot commented May 20, 2026

Copy link
Copy Markdown
Contributor

ClawSweeper PR egg

✨ Hatched: 🥚 common Sunspot Test Hopper

Hatch command

Comment @clawsweeper hatch when this PR is hatchable.

Hatchability rules:

  • Merged PRs are hatchable.
  • Open PRs are hatchable when they are status: 👀 ready for maintainer look, status: 🚀 automerge armed, or labeled clawsweeper:automerge.
  • Closed unmerged PRs are hatchable only when one of those hatchable labels is still present in the durable record.

Rarity: 🥚 common.
Trait: collects tiny proofs.
Image traits: location CI tidepool; accessory release bell; palette amber, ink, and glacier blue; mood sleepy but ready; pose standing beside its cracked shell; shell polished stone shell; lighting golden review-room light; background miniature CI buoys.
Share on X: post this hatch
Copy: My PR egg hatched a 🥚 common Sunspot Test Hopper in ClawSweeper.

What is this egg doing here?
  • Eggs appear after the PR passes real-behavior proof. It is here for vibes, not verdicts: it does not change labels, ratings, merge decisions, or automation.
  • The shell reacts to review momentum: open follow-up work warms it up, re-review makes it wobble, and a clean final review lets it hatch.
  • Hatchability usually comes from sufficient real-behavior proof, no blocking P0/P1/P2 findings, no security attention needed, and clean correctness. A merged PR is already final, so merge makes the egg hatchable independently.
  • The hatch is seeded from this repository and PR number, so the same PR keeps the same creature; the reviewed head SHA can only change safe visual details.
  • Rarity is just collectible sparkle: 🥚 common, 🌱 uncommon, 💎 rare, ✨ glimmer, and 🌈 legendary.

@steipete

Copy link
Copy Markdown
Contributor

Maintainer verification:

  • Checked the Voyage setup docs against current VOYAGE_API_KEY, models.providers.voyage.apiKey, and openclaw memory status --deep docs/source references.
  • Existing PR checks include check-docs pass and Real behavior proof pass.
  • No local runtime command needed; docs-only plugin setup clarification.

@steipete steipete merged commit 57178b1 into openclaw:main May 22, 2026
63 of 67 checks passed
@luoyanglang luoyanglang deleted the wolf/voyage-api-key-docs branch May 22, 2026 20:48
SebTardif pushed a commit to SebTardif/openclaw that referenced this pull request May 24, 2026
SebTardif pushed a commit to SebTardif/openclaw that referenced this pull request May 24, 2026
SebTardif pushed a commit to SebTardif/openclaw that referenced this pull request May 24, 2026
github-actions Bot pushed a commit to Desicool/openclaw that referenced this pull request May 24, 2026
galiniliev pushed a commit to galiniliev/openclaw that referenced this pull request May 25, 2026
SebTardif pushed a commit to SebTardif/openclaw that referenced this pull request May 26, 2026
SebTardif pushed a commit to SebTardif/openclaw that referenced this pull request May 26, 2026
SebTardif pushed a commit to SebTardif/openclaw that referenced this pull request May 26, 2026
jameslcowan pushed a commit to jameslcowan/openclaw that referenced this pull request Jun 2, 2026
SYU8384 pushed a commit to SYU8384/openclaw that referenced this pull request Jun 3, 2026
sablehead pushed a commit to sablehead/openclaw that referenced this pull request Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation P3 Low-priority cleanup, docs, polish, ergonomics, or speculative work. proof: supplied External PR includes structured after-fix real behavior proof. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. size: XS status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: how to add voyage api key? the documentation is too vague. why cant we have straightforward docs?

3 participants