add-provider-doc

Automate provider documentation workflows with structured frontmatter and Docker configs.

Updated Dec 12, 2024
One-click install
npx skills add https://github.com/kingmacth/lobe-chat --skill add-provider-doc-kingmacth
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-provider-doc
Source: https://github.com/kingmacth/lobe-chat/tree/main/.agents/skills/add-provider-doc
Command: npx skills add https://github.com/kingmacth/lobe-chat --skill add-provider-doc-kingmacth

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the setup and coordination of comprehensive provider documentation workflows for new AI services, consolidating usage guides, environment-variable references, Docker configurations, and asset preparation into a single, repeatable process.

Core Features & Use Cases

  • End-to-end documentation workflow: generates provider usage docs, environment-variable mappings, and Docker config blocks for quick onboarding across EN and CN.
  • Asset and reference prep: outlines required images, references, and sample configurations to ensure consistent documentation quality.
  • Onboarding and compliance checks: validates that no real API keys are included and that documentation adheres to project conventions.

Quick Start

Follow the five-step workflow to document a new AI provider end-to-end, including usage docs, environment-variable references, Docker config, and image assets.

Frequently Asked Questions about add-provider-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate AI provider documentation for onboarding new services?

You can automate AI provider documentation by generating usage guides, environment-variable references, and Docker configurations in a structured workflow. This process enforces frontmatter metadata and validates compliance, consolidating assets into a repeatable onboarding system for new services.

What is the best way to maintain environment variable references and Docker configs for AI providers?

Maintaining environment variable references and Docker configurations requires a structured documentation workflow that captures metadata for safety checks. This ensures no real API keys are included and organizes configurations alongside required images, scripts, and references for consistent quality.

How do I document new AI providers across both English and Chinese?

Documenting new AI providers across English and Chinese requires a coordinated workflow that generates bilingual usage docs, environment-variable references, and Docker configurations. This ensures consistent asset preparation and documentation quality across both languages.

Does the provider documentation workflow support optional directories for scripts and references?

Yes, the provider documentation workflow supports optional directories including scripts, references, and assets. This structure allows teams to organize sample configurations and required images while maintaining structured frontmatter with name and description for metadata discovery.

How do I prevent real API keys from being included in AI provider documentation?

Preventing real API keys in AI provider documentation requires compliance checks that validate project conventions. This skill enforces safety checks during the documentation workflow to ensure no actual API keys are committed alongside environment-variable references and Docker configurations.

What do I need to set up before onboarding documentation for a new AI provider?

Before onboarding documentation for a new AI provider, you need structured frontmatter with name and description, plus optional directories for scripts, references, and assets. This establishes the metadata foundation for discovery and prepares configurations for environment variables and Docker.