add-provider-doc_skill

This skill guides you through creating and updating provider documentation, env vars, Docker configs, and image resources for new AI providers.
  • TypeScript

70.5k

GitHub Stars

1

Bundled Files

3 weeks ago

Catalog Refreshed

2 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstart where the catalogue uses aiagentskills.

npx veilstart add skill lobehub/lobe-chat --skill add-provider-doc

  • SKILL.md2.2 KB

Overview

This skill guides contributors through adding documentation and configuration for a new AI provider. It covers usage pages, environment variables, Docker updates, .env.example changes, and required image assets. The goal is consistent, localized docs plus safe, reproducible configuration without exposing real keys.

How this skill works

It inspects the repository layout and prescribes the files and sections to create or update, including English and Chinese usage pages. It specifies exact environment variable entries, Dockerfile ENV additions, and .env.example patterns. It also lists required images and hosting expectations so assets are ready for CDN upload.

When to use it

  • Adding a new AI provider integration (OpenAI, Anthropic, Gemini, etc.)
  • Creating usage guides for provider features and setup
  • Updating self-hosted environment variable references
  • Preparing Docker and example environment configs for deployment

Best practices

  • Always produce both English and Simplified Chinese usage docs for parity
  • Include 5–6 screenshots showing registration, dashboard, and setup steps
  • Use placeholder API keys only; never paste real keys into docs or examples
  • Add environment variable docs with TYPE/Description/Example blocks exactly as specified
  • Update all three Dockerfiles and the .env.example to avoid runtime surprises

Example use cases

  • Add docs and assets for a new provider so users can configure it via the UI and .env
  • Document provider model mappings using {PROVIDER}_MODEL_LIST examples to control visible models
  • Prepare Docker ENV defaults so containers start with empty placeholders for keys
  • Provide clear pricing and dashboard links so teams can evaluate provider costs quickly

FAQ

Yes. Create an English and a Simplified Chinese usage document so the product remains bilingual and consistent.

What images are required and where should they be hosted?

Provide a cover image, 3–4 API dashboard screenshots, and 2–3 LobeChat config screenshots. Host them on the LobeHub CDN (hub-apac-1.lobeobjects.space) and reference CDN URLs in the docs.

Built by
VeilStrat
AI signals for GTM teams
© 2026 VeilStrat. All rights reserved.All systems operational