From 4f3b843efe492fbda6ef2569355d6c5d052c4abc Mon Sep 17 00:00:00 2001 From: Ishaan Jaffer Date: Thu, 4 Dec 2025 18:32:23 -0800 Subject: [PATCH] docs openai --- docs/my-website/docs/provider_registration/index.md | 6 ++++++ docs/my-website/sidebars.js | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/my-website/docs/provider_registration/index.md b/docs/my-website/docs/provider_registration/index.md index 66f61554783..60570dee7b7 100644 --- a/docs/my-website/docs/provider_registration/index.md +++ b/docs/my-website/docs/provider_registration/index.md @@ -2,6 +2,12 @@ title: "Integrate as a Model Provider" --- +## Quick Start for OpenAI-Compatible Providers + +If your API is OpenAI-compatible, you can add support by editing a single JSON file. See [Adding OpenAI-Compatible Providers](/docs/contributing/adding_openai_compatible_providers) for the simple approach. + +--- + This guide focuses on how to setup the classes and configuration necessary to act as a chat provider. Please see this guide first and look at the existing code in the codebase to understand how to act as a different provider, e.g. handling embeddings or image-generation. diff --git a/docs/my-website/sidebars.js b/docs/my-website/sidebars.js index faec93de1dc..cebe31a8e11 100644 --- a/docs/my-website/sidebars.js +++ b/docs/my-website/sidebars.js @@ -490,6 +490,11 @@ const sidebars = { id: "provider_registration/index", label: "Integrate as a Model Provider", }, + { + type: "doc", + id: "contributing/adding_openai_compatible_providers", + label: "Add OpenAI-Compatible Provider (JSON)", + }, { type: "doc", id: "provider_registration/add_model_pricing", @@ -814,6 +819,7 @@ const sidebars = { type: "category", label: "Adding Providers", items: [ + "contributing/adding_openai_compatible_providers", "adding_provider/directory_structure", "adding_provider/new_rerank_provider", ]