add-provider-doc

Generate EN and CN provider documentation with environment variables and Docker templates.

81.4k|15.8k|Updated May 21, 2023
One-click install
npx skills add https://github.com/lobehub/lobehub --skill add-provider-doc-lobehub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-provider-doc
Source: https://github.com/lobehub/lobehub/tree/main/.agents/skills/add-provider-doc
Command: npx skills add https://github.com/lobehub/lobehub --skill add-provider-doc-lobehub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create consistent, ready-to-use documentation packages for new AI providers, covering usage guides, environment variables, Docker configurations, and assets, reducing onboarding time and errors.

Core Features & Use Cases

  • Provider Onboarding: Generate EN and CN usage documents and reference materials for new providers.
  • Environment & Docker Docs: Provide standardized environment variable details and Docker configuration templates.
  • Artifact Management: Prepare and organize image resources and references for quick deployment.
  • Use Case: When adding a new provider, generate a complete docs bundle that teams can customize and publish.

Quick Start

To start documenting a new provider, create the usage docs at docs/usage/providers/{provider-name}.mdx (EN) and docs/usage/providers/{provider-name}.zh-CN.mdx (CN), add environment-variable docs, and update Docker and asset references as described.

Frequently Asked Questions about add-provider-doc

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

FAQPage Schema
How do I generate standardized documentation for onboarding a new AI provider?

To generate provider documentation, you create usage docs in MDX format, add environment variable details, and update Docker configurations and image references. This structured workflow ensures consistent, repeatable documentation packages for new AI providers.

What is included in an end-to-end provider documentation bundle?

An end-to-end provider documentation bundle includes EN and CN usage guides, standardized environment variable details, Docker configuration templates, and organized image resources to support quick deployment and onboarding.

How do I set up bilingual usage documents for a new provider?

You set up bilingual usage documents by creating an English MDX file at docs/usage/providers/{provider-name}.mdx and a Chinese file at docs/usage/providers/{provider-name}.zh-CN.mdx, then applying the frontmatter-driven format.

Can I use frontmatter to enforce a consistent documentation structure across different providers?

Yes, you can use a frontmatter-driven format to enforce a consistent documentation structure. This approach ensures that environment variables, Docker configs, and usage guides remain standardized across all newly onboarded providers.

What's the best way to automate Docker configuration and environment variable documentation for provider onboarding?

The best way to automate this is by using standardized templates that generate Docker configuration and environment variable docs simultaneously. This reduces manual errors and ensures all required deployment references are prepared.

Why do my provider onboarding docs lack consistency across different team members?

Provider onboarding docs lack consistency when they are not generated using a structured, frontmatter-driven format and standardized resource templates. Automating the end-to-end workflow enforces a repeatable structure and reduces onboarding errors.