Skip to content

Commit

Permalink
(docs) simplify left nav names + use a section for `making llm reques…
Browse files Browse the repository at this point in the history
…ts` (BerriAI#6799)

* fix emojis on docs

* add section on making LLM requests

* docs simplify sidebar
  • Loading branch information
ishaan-jaff authored Nov 18, 2024
1 parent bbdec29 commit 7bb5304
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs/my-website/docs/pass_through/anthropic_completion.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Anthropic `/v1/messages`
# Anthropic SDK

Pass-through endpoints for Anthropic - call provider-specific endpoint, in native format (no translation).

Expand Down
2 changes: 1 addition & 1 deletion docs/my-website/docs/pass_through/cohere.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Cohere API
# Cohere SDK

Pass-through endpoints for Cohere - call provider-specific endpoint, in native format (no translation).

Expand Down
2 changes: 1 addition & 1 deletion docs/my-website/docs/pass_through/google_ai_studio.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Google AI Studio
# Google AI Studio SDK

Pass-through endpoints for Google AI Studio - call provider-specific endpoint, in native format (no translation).

Expand Down
2 changes: 1 addition & 1 deletion docs/my-website/docs/pass_through/langfuse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Langfuse Endpoints
# Langfuse SDK

Pass-through endpoints for Langfuse - call langfuse endpoints with LiteLLM Virtual Key.

Expand Down
2 changes: 1 addition & 1 deletion docs/my-website/docs/pass_through/vertex_ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Image from '@theme/IdealImage';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# [BETA] Vertex AI Endpoints
# Vertex AI SDK

Use VertexAI SDK to call endpoints on LiteLLM Gateway (native provider format)

Expand Down
2 changes: 1 addition & 1 deletion docs/my-website/docs/proxy/pass_through.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Image from '@theme/IdealImage';

# ➡️ Create Pass Through Endpoints
# Create Pass Through Endpoints

Add pass through routes to LiteLLM Proxy

Expand Down
2 changes: 1 addition & 1 deletion docs/my-website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ const config = {
{
sidebarId: 'tutorialSidebar',
position: 'left',
label: '🚀 Hosted',
label: 'Hosted',
to: "docs/hosted"
},
{
Expand Down
65 changes: 34 additions & 31 deletions docs/my-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ const sidebars = {
"proxy/model_management",
"proxy/health",
"proxy/debugging",
"proxy/pass_through",
],
},
"proxy/demo",
Expand All @@ -50,13 +51,24 @@ const sidebars = {
},
{
type: "link",
label: "📖 All Endpoints (Swagger)",
label: "All Endpoints (Swagger)",
href: "https://litellm-api.up.railway.app/",
},
"proxy/enterprise",
"proxy/user_keys",
"proxy/response_headers",
"proxy/reliability",
{
type: "category",
label: "Making LLM Requests",
items: [
"proxy/user_keys",
"proxy/response_headers",
"pass_through/vertex_ai",
"pass_through/google_ai_studio",
"pass_through/cohere",
"pass_through/anthropic_completion",
"pass_through/bedrock",
"pass_through/langfuse"
],
},
{
type: "category",
label: "Authentication",
Expand All @@ -70,40 +82,29 @@ const sidebars = {
"proxy/multiple_admins",
],
},
{
type: "category",
label: "Admin UI",
items: [
"proxy/ui",
"proxy/self_serve",
"proxy/custom_sso"
],
},
{
type: "category",
label: "Spend Tracking + Budgets",
items: ["proxy/cost_tracking", "proxy/users", "proxy/custom_pricing", "proxy/team_budgets", "proxy/billing", "proxy/customers"],
},
"proxy/reliability",
{
type: "category",
label: "Routing",
items: ["proxy/load_balancing", "proxy/tag_routing", "proxy/team_based_routing", "proxy/customer_routing",],
},
{
type: "category",
label: "Pass-through Endpoints (Provider-specific)",
items: [
"pass_through/vertex_ai",
"pass_through/google_ai_studio",
"pass_through/cohere",
"pass_through/anthropic_completion",
"pass_through/bedrock",
"pass_through/langfuse"
],
},
{
type: "category",
label: "Admin UI",
items: [
"proxy/ui",
"proxy/self_serve",
"proxy/custom_sso"
],
},
{
type: "category",
label: "🪢 Logging, Alerting, Metrics",
label: "Logging, Alerting, Metrics",
items: ["proxy/logging", "proxy/bucket", "proxy/team_logging","proxy/streaming_logging", "proxy/alerting", "proxy/prometheus",],
},
{
Expand All @@ -123,14 +124,13 @@ const sidebars = {
},
{
type: "category",
label: "Secret Manager - storing LLM API Keys",
label: "Secret Managers",
items: [
"secret",
"oidc"
]
},
"proxy/caching",
"proxy/pass_through",
"proxy/call_hooks",
"proxy/rules",
]
Expand Down Expand Up @@ -233,7 +233,7 @@ const sidebars = {
},
{
type: "category",
label: "Supported Endpoints - /images, /audio/speech, /assistants etc",
label: "Supported Endpoints",
items: [
"embedding/supported_embedding",
"image_generation",
Expand All @@ -251,8 +251,11 @@ const sidebars = {
},
],
},
"routing",
"scheduler",
{
type: "category",
label: "Load Balancing",
items: ["routing", "scheduler"],
},
{
type: "category",
label: "LiteLLM Python SDK",
Expand Down

0 comments on commit 7bb5304

Please sign in to comment.