提供商文档添加_add-provider-doc
2026/7/23 20:43:09 网站建设 项目流程

以下为本文档的中文说明

该技能用于为新的AI提供商添加完整的文档支持,包括使用文档、环境变量说明、Docker配置和图片资源。主要功能是自动化完成新AI提供商接入所需的全部文档工作流程。使用场景包括:当LobeHub需要集成新的AI模型提供商时;需要创建提供商的中英文使用文档;需要更新环境变量说明和Docker配置文件。核心步骤包括:创建提供商使用文档(英文和中文双语版本);添加环境变量文档(也需双语);更新Docker配置文件;更新.env.example示例文件;准备截图等图片资源。关键要求包括:每个提供商需要5-6张操作流程截图、一张封面图片;使用真实的注册和面板URL;包含定价信息的标注说明;绝对不要在文档中包含真实的API密钥——必须使用占位符。该技能确保新AI提供商的接入过程标准化、文档完备化,降低集成门槛。


Adding New AI Provider Documentation

Complete workflow for adding documentation for a new AI provider.

Overview

  1. Create usage documentation (EN + CN)
  2. Add environment variable documentation (EN + CN)
  3. Update Docker configuration files
  4. Update .env.example
  5. Prepare image resources

Step 1: Create Provider Usage Documentation

Required Files

  • docs/usage/providers/{provider-name}.mdx(English)
  • docs/usage/providers/{provider-name}.zh-CN.mdx(Chinese)

Key Requirements

  • 5-6 screenshots showing the process
  • Cover image for the provider
  • Real registration and dashboard URLs
  • Pricing information callout
  • Never include real API keys- use placeholders

Reference:docs/usage/providers/fal.mdx

Step 2: Update Environment Variables Documentation

Files to Update

  • docs/self-hosting/environment-variables/model-provider.mdx(EN)
  • docs/self-hosting/environment-variables/model-provider.zh-CN.mdx(CN)

Content Format

### `{PROVIDER}_API_KEY` - Type: Required - Description: API key from {Provider Name} - Example: `{api-key-format}` ### `{PROVIDER}_MODEL_LIST` - Type: Optional - Description: Control model list. Use `+` to add, `-` to hide - Example: `-all,+model-1,+model-2=Display Name`

Step 3: Update Docker Files

Update all Dockerfiles at theendof ENV section:

  • Dockerfile
  • Dockerfile.database
  • Dockerfile.pglite
# {New Provider} {PROVIDER}_API_KEY="" {PROVIDER}_MODEL_LIST=""

Step 4: Update .env.example

### {Provider Name} #### {PROVIDER}_API_KEY={prefix}-xxxxxxxx

Step 5: Image Resources

  • Cover image
  • 3-4 API dashboard screenshots
  • 2-3 LobeHub configuration screenshots
  • Host on LobeHub CDN:hub-apac-1.lobeobjects.space

Checklist

  • EN + CN usage docs
  • EN + CN env var docs
  • All 3 Dockerfiles updated
  • .env.example updated
  • All images prepared
  • No real API keys in docs
    3d:[“","","","L3f”,null,{“content”:“$40”,“frontMatter”:{“name”:“add-provider-doc”,“description”:“Add documentation for a new AI provider — usage docs, env vars, Docker config, image resources.”,“disable-model-invocation”:true,“argument-hint”:“[provider-name]”}}]

41:I[471044,[“/_next/static/chunks/051aanbhrv4br.js”,“/_next/static/chunks/0mizr60h7ayzt.js”,“/_next/static/chunks/0v9lm1dmbdoo-.js”,“/_next/static/chunks/0rxr1j1j3j-.r.js”,“/_next/static/chunks/02ftybezfvqjd.js”,“/_next/static/chunks/0.v9ksvnnj8ia.js”,“/_next/static/chunks/0bn6id96nx3k.js",“/_next/static/chunks/13ybnhn37c.tc.js”,“/_next/static/chunks/0_fnrdtruz8uf.js”,“/_next/static/chunks/0r6l15utt1mwb.js”,“/_next/static/chunks/0dm9a5into854.js”,"/_next/static/chunks/07k6hqoibtcn.js”,“/next/static/chunks/0b4cao.4y…j.js”,“/_next/static/chunks/02i-n28z7kjd0.js”],“SkillSidebar”]
3a:[“","","","L41”,null,{“skill”:“KaTeX parse error: Expected 'EOF', got '}' at position 375: …de":"27-3042"}]}̲] 3e:["”,“section”,null,{“aria-labelledby”:“related-skills-heading”,“className”:“mt-8 overflow-hidden rounded-lg border border-border bg-card”,“children”:[[“KaTeX parse error: Expected '}', got 'EOF' at end of input: …,"children":[["”,“div”,null,{“className”:“flex min-w-0 items-center gap-2”,“children”:[“KaTeX parse error: Expected 'EOF', got '}' at position 108: …同仓库更多 Skills"}]}̲],["”,“span”,null,{“className”:“shrink-0 text-xs text-muted-foreground”,“children”:“同仓库”}]]}],[“KaTeX parse error: Expected '}', got 'EOF' at end of input: …,"children":[["”,“h2”,null,{“id”:“related-skills-heading”,“className”:“text-2xl font-semibold tracking-normal text-foreground”,“children”:“同仓库更多 Skills”}],[“KaTeX parse error: Expected '}', got 'EOF' at end of input: …","children":["L42”,“L43","L43","L43","L44”,“L45","L45","L45","L46”,“$L47”]}]]}]]}]

48:I[206516,[“/_next/static/chunks/051aanbhrv4br.js”,“/_next/static/chunks/0mizr60h7ayzt.js”,“/_next/static/chunks/0v9lm1dmbdoo-.js”,“/_next/static/chunks/0rxr1j1j3j-.r.js”,“/_next/static/chunks/02ftybezfvqjd.js”,“/_next/static/chunks/0.v9ksvnnj8ia.js”,“/_next/static/chunks/0bn6id96nx3k.js",“/_next/static/chunks/13ybnhn37c.tc.js”,“/_next/static/chunks/0_fnrdtruz8uf.js”,“/_next/static/chunks/0r6l15utt1mwb.js”,“/_next/static/chunks/0dm9a5into854.js”,"/_next/static/chunks/07k6hqoibtcn.js”,“/next/static/chunks/0b4cao.4y…j.js”,“/_next/static/chunks/02i-n28z7kjd0.js”],“default”]

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询