scriptoriumadmin/litellm
1
0
Fork 0
mirror of https://github.com/BerriAI/litellm.git synced 2026-09-07 08:26:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 36

docs: sidebar QA fixes and index updates

Browse source 
- Fix duplicate docs: RBAC and MCP Troubleshooting cross-links in secondary positions
- Add observability_index for Integrations
- Update guides, integrations, learn, tutorials index pages

Made-with: Cursor
This commit is contained in:
Mr. Ånand 2026-03-17 17:41:58 +05:30
parent 92f830ebea
commit d2ea8c15e3
6 changed files with 313 additions and 245 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
docs/my-website/docs/guides/index.md
View file

@ -11,48 +11,56 @@ import NavigationCards from '@site/src/components/NavigationCards';
---
## Model Configuration
## Core Features
<NavigationCards
columns={2}
items={[
{
icon: "🎛️",
title: "Fine-tuned Models",
description: "Call fine-tuned OpenAI, Azure, and Vertex AI models using LiteLLM with custom model names.",
to: "/docs/guides/finetuned_models",
},
{
icon: "⚡",
title: "Completion Basics",
description: "Streaming, function calling, JSON mode, vision, audio, and more.",
to: "/docs/guides/completion_basics",
},
{
icon: "📥",
title: "Documents, Images & Messages",
description: "Document understanding, image generation, message trimming, and sanitization.",
to: "/docs/guides/input_output_handling",
},
{
icon: "🔄",
title: "Prompt Optimization",
description: "Prompt caching and prompt formatting for better performance.",
to: "/docs/guides/prompt_optimization",
},
{
icon: "🤖",
title: "AI Capabilities",
description: "Web search, code interpreter, knowledge base, and more.",
to: "/docs/guides/ai_capabilities",
},
]}
/>
---
## Security & Networking
## Configuration & Cost
<NavigationCards
columns={2}
items={[
{
icon: "🔒",
title: "Security Settings",
description: "Configure SSL certificates and HTTP proxy settings for secure LiteLLM deployments.",
to: "/docs/guides/security_settings",
},
{
icon: "🎛️",
title: "Models & Configuration",
description: "Fine-tuned models, security settings, and adapters.",
to: "/docs/guides/models_configuration",
},
{
icon: "💰",
title: "Budgets & Cost",
description: "Set spend limits and track costs across teams and deployments.",
to: "/docs/guides/budgets_cost",
},
]}
/>
---
## AI Capabilities
<NavigationCards
columns={2}
items={[
{
icon: "🖥️",
title: "Code Interpreter",
description: "Use OpenAI's Code Interpreter tool to execute Python code in a secure, sandboxed environment.",
to: "/docs/guides/code_interpreter",
},
]}
/>
/>

34
docs/my-website/docs/integrations/index.md
View file

@ -20,60 +20,60 @@ items={[
icon: "🪢",
title: "Langfuse",
description: "LLM observability and analytics.",
to: "../observability/langfuse_integration",
to: "/docs/observability/langfuse_integration",
},
{
icon: "🐶",
title: "Datadog",
description: "Metrics, traces, and dashboards.",
to: "../observability/datadog",
to: "/docs/observability/datadog",
},
{
icon: "📡",
title: "OpenTelemetry",
description: "Vendor-neutral tracing.",
to: "../observability/opentelemetry_integration",
to: "/docs/observability/opentelemetry_integration",
},
{
icon: "🔗",
title: "LangSmith",
description: "LLM debugging and evaluation.",
to: "../observability/langsmith_integration",
to: "/docs/observability/langsmith_integration",
},
{
icon: "🔥",
title: "Arize / Phoenix",
description: "ML observability and evaluation.",
to: "../observability/arize_integration",
to: "/docs/observability/arize_integration",
},
{
icon: "🌀",
title: "Helicone",
description: "LLM request logging and analytics.",
to: "../observability/helicone_integration",
to: "/docs/observability/helicone_integration",
},
{
icon: "📊",
title: "MLflow",
description: "Experiment tracking.",
to: "../observability/mlflow",
to: "/docs/observability/mlflow",
},
{
icon: "🏋️",
title: "Weights & Biases",
description: "ML experiment tracking.",
to: "../observability/wandb_integration",
to: "/docs/observability/wandb_integration",
},
{
icon: "📉",
title: "PostHog",
description: "Product analytics.",
to: "../observability/posthog_integration",
to: "/docs/observability/posthog_integration",
},
]}
/>
[View all observability integrations →](../observability/callbacks.md)
[View all observability integrations →](/docs/observability_integrations)
---
@ -124,42 +124,42 @@ items={[
icon: "🛡️",
title: "Lakera AI",
description: "Prompt injection detection.",
to: "../proxy/guardrails/lakera_ai",
to: "/docs/proxy/guardrails/lakera_ai",
},
{
icon: "☁️",
title: "Azure Content Safety",
description: "Content moderation.",
to: "../proxy/guardrails/azure_content_guardrail",
to: "/docs/proxy/guardrails/azure_content_guardrail",
},
{
icon: "🛏️",
title: "Bedrock Guardrails",
description: "AWS Bedrock safety.",
to: "../proxy/guardrails/bedrock",
to: "/docs/proxy/guardrails/bedrock",
},
{
icon: "🤖",
title: "OpenAI Moderation",
description: "OpenAI content policy.",
to: "../proxy/guardrails/openai_moderation",
to: "/docs/proxy/guardrails/openai_moderation",
},
{
icon: "🔐",
title: "Secret Detection",
description: "Prevent credential leaks.",
to: "../proxy/guardrails/secret_detection",
to: "/docs/proxy/guardrails/secret_detection",
},
{
icon: "🕵️",
title: "PII Masking",
description: "Mask sensitive data.",
to: "../proxy/guardrails/pii_masking_v2",
to: "/docs/proxy/guardrails/pii_masking_v2",
},
]}
/>
[View all guardrail providers →](../proxy/guardrails/quick_start.md)
[View all guardrail providers →](/docs/guardrail_providers)
---

28
docs/my-website/docs/integrations/observability_index.md Normal file
View file

@ -0,0 +1,28 @@
---
title: Observability
sidebar_label: Overview
slug: observability_integrations
---
Track, debug, and analyze LLM calls with observability platforms.
import NavigationCards from '@site/src/components/NavigationCards';
## Observability Integrations
<NavigationCards
columns={3}
items={[
{ icon: "🪢", title: "Langfuse", description: "LLM observability and analytics.", to: "/docs/observability/langfuse_integration" },
{ icon: "🐶", title: "Datadog", description: "Metrics, traces, and dashboards.", to: "/docs/observability/datadog" },
{ icon: "📡", title: "OpenTelemetry", description: "Vendor-neutral tracing.", to: "/docs/observability/opentelemetry_integration" },
{ icon: "🔗", title: "LangSmith", description: "LLM debugging and evaluation.", to: "/docs/observability/langsmith_integration" },
{ icon: "🔥", title: "Arize / Phoenix", description: "ML observability and evaluation.", to: "/docs/observability/arize_integration" },
{ icon: "🌀", title: "Helicone", description: "LLM request logging and analytics.", to: "/docs/observability/helicone_integration" },
{ icon: "📊", title: "MLflow", description: "Experiment tracking.", to: "/docs/observability/mlflow" },
{ icon: "🏋️", title: "Weights & Biases", description: "ML experiment tracking.", to: "/docs/observability/wandb_integration" },
{ icon: "📉", title: "PostHog", description: "Product analytics.", to: "/docs/observability/posthog_integration" },
]}
/>
[View all observability integrations →](/docs/observability/callbacks)

152
docs/my-website/docs/learn/index.md
View file

@ -10,12 +10,12 @@ LiteLLM gives you a single OpenAI-compatible interface to 100+ LLM providers. Us
---
## 1. Make Your First Call
## Get Started
Set up your environment and call your first model.
Set up your environment and make your first LLM call.
<NavigationCards
columns={2}
columns={3}
items={[
{
icon: "⚡",
@ -29,113 +29,83 @@ items={[
description: "Compare multiple LLM providers side by side in under 10 minutes with Streamlit.",
to: "/docs/tutorials/first_playground",
},
{
icon: "📞",
title: "Make Your First Call",
description: "Use the completion() function to call OpenAI, Anthropic, Vertex, or 100+ providers — same interface, one line of code.",
to: "/docs/#quick-start",
},
]}
/>
[View all getting started tutorials →](/docs/tutorials/getting_started)
---
## 2. Connect Your Tools
## Guides
Point your existing tools and frameworks at LiteLLM.
Focused references for SDK features and proxy configuration. Each guide is self-contained.
<NavigationCards
columns={2}
columns={3}
items={[
{
icon: "⚡",
title: "Completion Basics",
description: "Streaming, function calling, JSON mode, vision, audio, and more.",
to: "/docs/guides/completion_basics",
},
{
icon: "🎛️",
title: "Models & Configuration",
description: "Fine-tuned models, security settings, and adapters.",
to: "/docs/guides/models_configuration",
},
{
icon: "💰",
title: "Budgets & Cost",
description: "Set spend limits and track costs across teams and deployments.",
to: "/docs/guides/budgets_cost",
},
]}
/>
[View all guides →](/docs/guides)
---
## Tutorials
Step-by-step walkthroughs for integrating LiteLLM with external tools and services.
<NavigationCards
columns={3}
items={[
{
icon: "🤖",
title: "Agent SDKs & Frameworks",
description: "OpenAI Agents SDK, Claude Agent SDK, Google ADK, CopilotKit, and more.",
to: "/docs/agent_sdks",
},
{
icon: "🛠️",
title: "AI Coding Tools",
description: "Route Claude Code, Cursor, GitHub Copilot, Gemini CLI, and OpenAI Codex through LiteLLM.",
to: "/docs/tutorials/cursor_integration",
},
{
icon: "🤖",
title: "Agent Frameworks",
description: "Use LiteLLM with OpenAI Agents SDK, Claude Agent SDK, Google ADK, CopilotKit, and more.",
to: "/docs/tutorials/openai_agents_sdk",
description: "Claude Code, Cursor, GitHub Copilot, Gemini CLI, OpenCode, and more.",
to: "/docs/ai_tools",
},
{
icon: "🐍",
title: "Provider Setup",
description: "Configure Azure OpenAI, HuggingFace, TogetherAI, local models, and 100+ other providers.",
to: "/docs/tutorials/azure_openai",
},
{
icon: "💬",
title: "Chat Interfaces",
description: "Connect LiteLLM to OpenWebUI, LangChain, and other chat frontends.",
to: "/docs/tutorials/openweb_ui",
title: "Provider Tutorials",
description: "Set up Azure OpenAI, HuggingFace, TogetherAI, local models, and more.",
to: "/docs/tutorials/provider_tutorials",
},
]}
/>
[View all tutorials →](/docs/tutorials)
---
## 3. Configure LiteLLM
## Production
Learn how specific SDK features and proxy options work.
<NavigationCards
columns={2}
items={[
{
icon: "🎛️",
title: "Fine-tuned Models",
description: "Call fine-tuned OpenAI, Azure, and Vertex AI models with custom model names.",
to: "/docs/guides/finetuned_models",
},
{
icon: "🔒",
title: "Security Settings",
description: "Configure SSL certificates and HTTP proxy settings for secure deployments.",
to: "/docs/guides/security_settings",
},
{
icon: "🖥️",
title: "Code Interpreter",
description: "Execute Python code in a secure sandbox via OpenAI's Code Interpreter tool.",
to: "/docs/guides/code_interpreter",
},
{
icon: "⚙️",
title: "Advanced Techniques",
description: "Prompt caching, model fallbacks, tag management, and provider-specific parameters.",
to: "/docs/tutorials/prompt_caching",
},
]}
/>
---
## 4. Run in Production
Add observability, access control, and safety to your deployment.
<NavigationCards
columns={2}
items={[
{
icon: "🔍",
title: "Observability & Safety",
description: "Logging to Elasticsearch, Aporia guardrails, and Presidio PII masking.",
to: "/docs/tutorials/elasticsearch_logging",
},
{
icon: "👥",
title: "Access Control & Administration",
description: "SSO, SCIM, team onboarding, and spend tracking.",
to: "/docs/tutorials/default_team_self_serve",
},
{
icon: "📊",
title: "Evaluation & Benchmarking",
description: "Compare models, run evaluation suites, and benchmark with LM Evaluation Harness.",
to: "/docs/tutorials/compare_llms",
},
{
icon: "📈",
title: "Integrations Overview",
description: "Langfuse, Datadog, Prometheus, Guardrails, Prompt Management, and more.",
to: "/docs/integrations",
},
]}
/>
Add observability, access control, and safety to your deployment. See the [Production section](/docs/tutorials#production) in Tutorials for Observability & Safety, Proxy & Gateway, and more.

82
docs/my-website/docs/tutorials/index.md
View file

@ -18,73 +18,75 @@ columns={2}
items={[
{
icon: "⚡",
title: "Set Up Your Environment",
description: "Get your API keys for OpenAI, Cohere, and AI21 — no waitlist required — and configure your environment before making your first LLM call.",
to: "/docs/tutorials/installation",
},
{
icon: "🧪",
title: "Build an LLM Playground",
description: "Create a Streamlit playground to evaluate and compare multiple LLM providers side by side in under 10 minutes.",
to: "/docs/tutorials/first_playground",
title: "Getting Started",
description: "Installation, playground, text completion, and mock completions.",
to: "/docs/tutorials/getting_started",
},
]}
/>
---
## Browse All Tutorials
## Integrations
<NavigationCards
columns={2}
items={[
{
icon: "🤖",
title: "Agent Frameworks",
title: "Agent SDKs & Frameworks",
description: "OpenAI Agents SDK, Claude Agent SDK, Google ADK, CopilotKit, Letta, LiveKit, Instructor.",
to: "/docs/tutorials/openai_agents_sdk",
to: "/docs/agent_sdks",
},
{
icon: "🛠️",
title: "AI Coding Tools",
description: "Claude Code, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Qwen Code, OpenAI Codex.",
to: "/docs/tutorials/cursor_integration",
to: "/docs/ai_tools",
},
{
icon: "🐍",
title: "Provider Setup",
description: "Step-by-step setup for Azure OpenAI, HuggingFace, TogetherAI, local models, and more.",
to: "/docs/tutorials/azure_openai",
title: "Provider Tutorials",
description: "Set up Azure OpenAI, HuggingFace, TogetherAI, local models, Gradio, and more.",
to: "/docs/tutorials/provider_tutorials",
},
]}
/>
---
## Production
<NavigationCards
columns={2}
items={[
{
icon: "📊",
title: "Evaluation & Benchmarking",
description: "Compare LLMs side by side, run evaluation suites, and benchmark with LM Evaluation Harness.",
to: "/docs/tutorials/compare_llms",
icon: "🖥️",
title: "Proxy & Gateway",
description: "Access control, SSO, SCIM, tag management, and prompt caching.",
to: "/docs/tutorials/proxy_gateway",
},
{
icon: "🔍",
title: "Observability & Safety",
description: "Send logs to Elasticsearch and other platforms. Add Aporia guardrails and Presidio PII masking.",
to: "/docs/tutorials/elasticsearch_logging",
},
{
icon: "👥",
title: "Access Control & Administration",
description: "Onboard users to default teams, configure Microsoft SSO, set up SCIM, and track spend.",
to: "/docs/tutorials/default_team_self_serve",
},
{
icon: "🎙️",
title: "Realtime & Audio",
description: "Build real-time audio apps with Gemini and xAI via the LiteLLM proxy.",
to: "/docs/tutorials/gemini_realtime_with_audio",
},
{
icon: "⚙️",
title: "Advanced Techniques",
description: "Prompt caching, model fallbacks, tag management, provider-specific parameters, and more.",
to: "/docs/tutorials/prompt_caching",
description: "Logging to Elasticsearch, Aporia guardrails, Presidio PII masking, and evaluation suites.",
to: "/docs/tutorials/observability_safety",
},
]}
/>
---
## Advanced Features
<NavigationCards
columns={2}
items={[
{
icon: "⚙️",
title: "Advanced Features",
description: "Model fallbacks, provider-specific parameters, and realtime audio.",
to: "/docs/tutorials/advanced_features",
},
]}
/>

192
docs/my-website/sidebars.js
View file

@ -25,6 +25,7 @@ const sidebars = {
{
type: "category",
label: "Observability",
link: { type: "doc", id: "integrations/observability_index" },
items: [
{
type: "category",
@ -34,17 +35,23 @@ const sidebars = {
type: "autogenerated",
dirName: "contribute_integration"
}
]
],
},
{
type: "autogenerated",
dirName: "observability"
}
},
],
},
{
type: "category",
label: "Guardrail Providers",
link: {
type: "generated-index",
title: "Guardrail Providers",
description: "Add safety and content filtering to LLM calls",
slug: "/guardrail_providers"
},
items: [
...[
"proxy/guardrails/qualifire",
@ -161,6 +168,8 @@ const sidebars = {
"tutorials/copilotkit_sdk",
"tutorials/google_adk",
"tutorials/livekit_xai_realtime",
{ type: "doc", id: "tutorials/instructor", label: "Instructor with LiteLLM" },
{ type: "doc", id: "langchain/langchain", label: "LangChain with LiteLLM" },
"projects/openai-agents"
]
},
@ -305,7 +314,11 @@ const sidebars = {
"mcp_control",
"mcp_cost",
"mcp_guardrail",
"mcp_troubleshoot",
{
type: "link",
label: "MCP Troubleshooting Guide →",
href: "/docs/mcp_troubleshoot"
},
],
},
],
@ -367,7 +380,11 @@ const sidebars = {
type: "category",
label: "Teams & Organizations",
items: [
"proxy/access_control",
{
type: "link",
label: "Role-based Access Controls (RBAC) →",
href: "/docs/proxy/access_control"
},
"proxy/self_serve",
"proxy/public_teams",
"proxy/ui_project_management",
@ -462,7 +479,7 @@ const sidebars = {
{
type: "link",
label: "Providers →",
href: "/docs/integrations#guardrail-providers",
href: "/docs/guardrail_providers",
},
{
type: "category",
@ -1134,45 +1151,77 @@ const learnSidebar = {
items: [
{
type: "category",
label: "Completion & Messaging",
label: "Completion Basics",
collapsible: true,
collapsed: false,
link: {
type: "generated-index",
title: "Completion Basics",
description: "Streaming, function calling, JSON mode, vision, audio, and more",
slug: "/guides/completion_basics"
},
items: [
"completion/stream",
"completion/function_call",
"completion/json_mode",
"completion/vision",
"completion/audio",
"completion/document_understanding",
"completion/image_generation_chat",
"completion/batching",
"completion/prefix",
"completion/predict_outputs",
"completion/provider_specific_params",
"reasoning_content",
{
type: "category",
label: "Prompt Config",
collapsible: true,
collapsed: true,
items: [
"completion/prompt_caching",
"completion/prompt_formatting",
],
},
"completion/drop_params",
"completion/message_trimming",
"completion/message_sanitization",
"completion/model_alias",
"completion/mock_requests",
"completion/reliable_completions",
],
},
{
type: "category",
label: "Documents, Images & Messages",
collapsible: true,
collapsed: true,
link: {
type: "generated-index",
title: "Documents, Images & Messages",
description: "Document understanding, image generation, message trimming, and sanitization",
slug: "/guides/input_output_handling"
},
items: [
"completion/document_understanding",
"completion/image_generation_chat",
"completion/message_trimming",
"completion/message_sanitization",
],
},
{
type: "category",
label: "Prompt Optimization",
collapsible: true,
collapsed: true,
link: {
type: "generated-index",
title: "Prompt Optimization",
description: "Prompt caching and prompt formatting",
slug: "/guides/prompt_optimization"
},
items: [
"completion/prompt_caching",
"completion/prompt_formatting",
],
},
{
type: "category",
label: "AI Capabilities",
collapsible: true,
collapsed: true,
link: {
type: "generated-index",
title: "AI Capabilities",
description: "Web search, code interpreter, knowledge base, and more",
slug: "/guides/ai_capabilities"
},
items: [
"completion/web_search",
"completion/web_fetch",
@ -1180,22 +1229,40 @@ const learnSidebar = {
"completion/knowledgebase",
"guides/code_interpreter",
"proxy/veo_video_generation",
{ type: "doc", id: "rag_ingest", label: "RAG Ingest" },
{ type: "doc", id: "rag_query", label: "RAG Query" },
],
},
{
type: "category",
label: "Models & Customization",
label: "Models & Configuration",
collapsible: true,
collapsed: true,
link: {
type: "generated-index",
title: "Models & Configuration",
description: "Fine-tuned models, security settings, and adapters",
slug: "/guides/models_configuration"
},
items: [
"guides/finetuned_models",
"guides/security_settings",
"budget_manager",
"extras/creating_adapters",
],
},
{
type: "category",
label: "Budgets & Cost",
collapsible: true,
collapsed: true,
link: {
type: "generated-index",
title: "Budgets & Cost",
description: "Set spend limits and track costs",
slug: "/guides/budgets_cost"
},
items: [
"budget_manager",
],
},
],
},
@ -1211,64 +1278,39 @@ const learnSidebar = {
type: "category",
label: "Getting Started",
collapsed: false,
link: {
type: "generated-index",
title: "Getting Started",
description: "Installation, playground, text completion, and mock completions",
slug: "/tutorials/getting_started"
},
items: [
"tutorials/first_playground",
"tutorials/installation",
"tutorials/first_playground",
"tutorials/text_completion",
"tutorials/mock_completion",
],
},
{
type: "category",
type: "link",
label: "Agent SDKs & Frameworks",
collapsed: true,
items: [
"tutorials/openai_agents_sdk",
"tutorials/claude_agent_sdk",
"tutorials/copilotkit_sdk",
"tutorials/google_adk",
"tutorials/livekit_xai_realtime",
{ type: "doc", id: "tutorials/instructor", label: "Instructor with LiteLLM" },
{ type: "doc", id: "langchain/langchain", label: "LangChain with LiteLLM" },
],
href: "/docs/agent_sdks",
},
{
type: "category",
type: "link",
label: "AI Coding Tools",
collapsed: true,
items: [
"tutorials/openweb_ui",
{
type: "category",
label: "Claude Code",
collapsed: true,
items: [
"tutorials/claude_responses_api",
"tutorials/claude_code_max_subscription",
"tutorials/claude_code_customer_tracking",
"tutorials/claude_code_prompt_cache_routing",
"tutorials/claude_code_websearch",
"tutorials/claude_mcp",
"tutorials/claude_non_anthropic_models",
"tutorials/claude_code_plugin_marketplace",
"tutorials/claude_code_beta_headers",
],
},
"tutorials/cursor_integration",
"tutorials/github_copilot_integration",
"tutorials/opencode_integration",
"tutorials/openclaw_integration",
"tutorials/cost_tracking_coding",
"tutorials/litellm_gemini_cli",
"tutorials/litellm_qwen_code_cli",
"tutorials/openai_codex",
"tutorials/google_genai_sdk",
],
href: "/docs/ai_tools",
},
{
type: "category",
label: "Provider Tutorials",
collapsed: true,
link: {
type: "generated-index",
title: "Provider Tutorials",
description: "Set up Azure OpenAI, HuggingFace, TogetherAI, local models, and more",
slug: "/tutorials/provider_tutorials"
},
items: [
"tutorials/azure_openai",
"tutorials/TogetherAI_liteLLM",
@ -1285,6 +1327,12 @@ const learnSidebar = {
type: "category",
label: "Proxy & Gateway",
collapsed: true,
link: {
type: "generated-index",
title: "Proxy & Gateway",
description: "Access control, SSO, SCIM, tag management, and prompt caching",
slug: "/tutorials/proxy_gateway"
},
items: [
"tutorials/default_team_self_serve",
"tutorials/msft_sso",
@ -1298,6 +1346,12 @@ const learnSidebar = {
type: "category",
label: "Observability & Safety",
collapsed: true,
link: {
type: "generated-index",
title: "Observability & Safety",
description: "Logging, guardrails, PII masking, and evaluation suites",
slug: "/tutorials/observability_safety"
},
items: [
"tutorials/elasticsearch_logging",
"tutorials/litellm_proxy_aporia",
@ -1310,6 +1364,12 @@ const learnSidebar = {
type: "category",
label: "Advanced Features",
collapsed: true,
link: {
type: "generated-index",
title: "Advanced Features",
description: "Model fallbacks, provider-specific params, and realtime audio",
slug: "/tutorials/advanced_features"
},
items: [
"tutorials/model_fallbacks",
"tutorials/fallbacks",