Skip to content

Conversation

@Chesars
Copy link
Contributor

@Chesars Chesars commented Dec 6, 2025

Title

docs: improve Getting Started page and SDK documentation structure

Relevant issues

Addresses feedback from #16638

Pre-Submission checklist

  • Documentation-only PR - no code changes, tests not applicable
  • My PR's scope is as isolated as possible, it only solves 1 specific problem

Type

📖 Documentation

Changes

Getting Started page (index.md)

  • Updated supported endpoints list to include /responses, /audio, /batches
  • Fixed broken exception handling example (was using deprecated openai.error import)
  • Changed to use litellm.AuthenticationError

Sidebar reorganization (sidebars.js)

  • Renamed "LiteLLM - Getting Started" to "Getting Started"
  • Moved Python SDK section before AI Gateway
  • Renamed "LiteLLM AI Gateway" to "LiteLLM AI Gateway (Proxy)"
  • Restructured SDK section with subsections: Core Functions, Configuration
  • Moved budget_manager to Guides, sdk_custom_pricing and migration to Extras
  • Removed duplicate sidebar entries

Response API (response_api.md)

  • Added Response Format section with JSON example

Embeddings (embedding/supported_embedding.md)

  • Added aembedding() async usage section

Assistants API (assistants.md)

  • Added deprecation warning (OpenAI shutting down Assistants API on Aug 26, 2026)
  • Added link to Responses API migration guide

…eption handling

- Update endpoints list to include /responses, /audio, /batches
- Change "Consistent output" to be endpoint-agnostic
- Clarify Response Format title as "OpenAI Chat Completions Format"
- Fix exception handling example: use litellm exceptions instead of deprecated openai.error
- Add model prefix (anthropic/) to example
Sidebar changes:
- Reorder: Python SDK first, then AI Gateway (Proxy)
- Rename "LiteLLM - Getting Started" to "Getting Started"
- Restructure SDK section with Core Functions, Configuration subsections
- Move budget_manager to Guides
- Move sdk_custom_pricing and migration to Extras
- Remove duplicate embedding/async_embedding and embedding/moderation

Content changes:
- Add Response Format section to response_api.md
- Add async aembedding() section to supported_embedding.md
OpenAI has deprecated the Assistants API, shutting down on August 26, 2026.
Added warning banner directing users to the Responses API.
@vercel
Copy link

vercel bot commented Dec 6, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
litellm Ready Ready Preview Comment Dec 6, 2025 9:34pm

Add more SDK functions to Core Functions category:
- text_completion()
- image_generation()
- transcription()
- speech()
- Link to "All Supported Endpoints" for complete list
@Chesars
Copy link
Contributor Author

Chesars commented Dec 6, 2025

@Chesars Chesars marked this pull request as ready for review December 6, 2025 21:33
Copy link
Contributor

@ishaan-jaff ishaan-jaff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ishaan-jaff ishaan-jaff merged commit dcf5217 into BerriAI:main Dec 8, 2025
6 of 7 checks passed
@Chesars Chesars deleted the docs/update-getting-started-page branch December 9, 2025 03:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants