ReddRadar
Agent skill
add-provider-doc
Guide for adding new AI provider documentation. Use when adding documentation for a new AI provider (like OpenAI, Anthropic, etc.), including usage docs, environment variables, Docker config, and image resources. Triggers on provider documentation tasks.
Install this agent skill to your Project
npx add-skill https://github.com/lobehub/lobehub/tree/canary/.agents/skills/add-provider-doc
SKILL.md
Adding New AI Provider Documentation
Complete workflow for adding documentation for a new AI provider.
Overview
- Create usage documentation (EN + CN)
- Add environment variable documentation (EN + CN)
- Update Docker configuration files
- Update .env.example
- 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 the end of ENV section:
DockerfileDockerfile.databaseDockerfile.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
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
lobehub/lobehub
task
lobehub/lobehub
i18n
Internationalization guide using react-i18next. Use when adding translations, creating i18n keys, or working with localized text in React components (.tsx files). Triggers on translation tasks, locale management, or i18n implementation.
lobehub/lobehub
data-fetching
Data fetching architecture guide using Service layer + Zustand Store + SWR. Use when implementing data fetching, creating services, working with store hooks, or migrating from useEffect. Triggers on data loading, API calls, service creation, or store data fetching tasks.
lobehub/lobehub
recent-data
Guide for using Recent Data (topics, resources, pages). Use when working with recently accessed items, implementing recent lists, or accessing session store recent data. Triggers on recent data usage or implementation tasks.
lobehub/lobehub
hotkey
Guide for adding keyboard shortcuts. Use when implementing new hotkeys, registering shortcuts, or working with keyboard interactions. Triggers on hotkey implementation or keyboard shortcut tasks.
lobehub/lobehub
debug
Debug package usage guide. Use when adding debug logging, understanding log namespaces, or implementing debugging features. Triggers on debug logging requests or logging implementation.
Didn't find tool you were looking for?