-
-
Notifications
You must be signed in to change notification settings - Fork 5k
docs: improve Getting Started page and SDK documentation structure #17614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
ishaan-jaff
merged 7 commits into
BerriAI:main
from
Chesars:docs/update-getting-started-page
Dec 8, 2025
Merged
docs: improve Getting Started page and SDK documentation structure #17614
ishaan-jaff
merged 7 commits into
BerriAI:main
from
Chesars:docs/update-getting-started-page
Dec 8, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Add more SDK functions to Core Functions category: - text_completion() - image_generation() - transcription() - speech() - Link to "All Supported Endpoints" for complete list
Contributor
Author
|
See preview in https://litellm-o21mpb378-clerkieai.vercel.app/docs/ |
ishaan-jaff
approved these changes
Dec 8, 2025
Contributor
ishaan-jaff
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Title
docs: improve Getting Started page and SDK documentation structure
Relevant issues
Addresses feedback from #16638
Pre-Submission checklist
Type
📖 Documentation
Changes
Getting Started page (
index.md)/responses,/audio,/batchesopenai.errorimport)litellm.AuthenticationErrorSidebar reorganization (
sidebars.js)budget_managerto Guides,sdk_custom_pricingandmigrationto ExtrasResponse API (
response_api.md)Embeddings (
embedding/supported_embedding.md)aembedding()async usage sectionAssistants API (
assistants.md)