Skip to content

docs: add API key blocks to agent guides - #4141

Closed
ManAsWind wants to merge 1 commit into
volcengine:mainfrom
ManAsWind:fix/connect-agent-api-key-copy
Closed

docs: add API key blocks to agent guides#4141
ManAsWind wants to merge 1 commit into
volcengine:mainfrom
ManAsWind:fix/connect-agent-api-key-copy

Conversation

@ManAsWind

@ManAsWind ManAsWind commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

背景

OpenViking 控制台的「接入 Agent」页面会从 docs.openviking.net 拉取 Agent 接入文档,并在文档中的 API Key 占位位置注入当前页面可复制的 API Key。部分 Agent 文档只写了让用户复制/粘贴本页 API Key,但没有显式占位块,导致页面上缺少 API Key 展示和复制入口。

变更内容

  • 为中英文 CLI 接入文档补充 {{OPENVIKING_API_KEY_BLOCK}},使「API Key」步骤下方能渲染 API Key 展示与复制块。
  • 为中英文 OpenClaw 接入文档补充 API Key 提示和 {{OPENVIKING_API_KEY_BLOCK}},保留 upstream/main 上已有的一段式安装命令。
  • 为中英文 Hermes Agent 接入文档补充 {{OPENVIKING_API_KEY_BLOCK}}
  • 将中文 Hermes 文案 把本页 API Key 贴进去。 调整为 把本页 API Key 贴进去:,让后续展示的 API Key 块语义更连贯。
  • 为中英文 Cursor、TRAE 接入文档补充安装器输入 API Key 的提示和 {{OPENVIKING_API_KEY_BLOCK}}

影响范围

  • 仅影响 docs/images/agents/{zh,en} 下的 Agent 接入文档静态资源。
  • 不改运行时代码、不改 API、不影响 OpenViking 服务端逻辑。
  • 前端渲染时仍由 OpenViking 控制台负责把占位符替换为脱敏展示的 API Key;复制按钮继续复制完整真实值。

验证

  • pnpm --dir docs docs:build
  • git diff --cached --check

@yufeng201

Copy link
Copy Markdown
Collaborator

Closing as superseded by #4152 (42d3799), which built on the same "add API key blocks to agent guides" changes and extended them with {{OPENVIKING_BASE_URL}}/{{OPENVIKING_API_KEY}} template tokens, step renumbering, and copy refinements. Everything in this PR is already in main; merging it now would duplicate the {{OPENVIKING_API_KEY_BLOCK}} blocks in the touched files.

@yufeng201 yufeng201 closed this Aug 22, 2026
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project Aug 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants