Toolverse
Wszystkie skille

add-provider-doc

autor: lobehub

Kompletny przewodnik do dodawania dokumentacji nowych dostawców AI

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
lobehub
Kategoria
DevOps
Wyświetlenia
43

O skillu

Umiejętność wspomagająca tworzenie dokumentacji dla nowych dostawców modeli AI (OpenAI, Anthropic i innych). Zawiera workflow dla dokumentacji użytkownika, zmiennych środowiskowych, konfiguracji Docker i zasobów graficznych. Automatycznie aktywuje się przy zadaniach związanych z dokumentacją dostawcy. Obejmuje szablony dla wersji angielskiej i chińskiej, wymogi dotyczące zrzutów ekranu, informacji o cenach oraz bezpieczne placeholder'y zamiast rzeczywistych kluczy API.

Jak używać

  1. Utwórz dokumentację użytkownika dla dostawcy w dwóch wersjach: angielskiej (docs/usage/providers/{provider-name}.mdx) i chińskiej (docs/usage/providers/{provider-name}.zh-CN.mdx). Każda dokumentacja powinna zawierać 5-6 zrzutów ekranu procesu rejestracji, obraz okładki, rzeczywiste adresy URL rejestracji i panelu, informacje o cenach oraz placeholder'e zamiast rzeczywistych kluczy API.
  2. Zaktualizuj dokumentację zmiennych środowiskowych w plikach docs/self-hosting/environment-variables/model-provider.mdx (angielski) i model-provider.zh-CN.mdx (chiński). Dodaj sekcje dla {PROVIDER}_API_KEY (wymagane) i {PROVIDER}_MODEL_LIST (opcjonalne) z opisami, typami i przykładami formatów.
  3. Zaktualizuj wszystkie pliki Dockerfile (Dockerfile, Dockerfile.database, Dockerfile.pglite) na końcu sekcji zmiennych środowiskowych, dodając linie z nowymi zmiennymi dostawcy w formacie {PROVIDER}_API_KEY="" {PROVIDER}_MODEL_LIST="".
  4. Zaktualizuj plik .env.example, dodając sekcję dla nowego dostawcy z skomentowanymi zmiennymi w formacie # {PROVIDER}_API_KEY={prefix}-xxxxxxxx.
  5. Przygotuj zasoby graficzne: obraz okładki dostawcy oraz 3-4 zrzuty ekranu panelu API i interfejsu LobeCh, które będą używane w dokumentacji.

Podobne skille