docs(proxy): document the dark mode UI logo - #966
Merged
Conversation
UI_LOGO_PATH_DARK and the matching logo_url_dark theme setting let an admin supply a logo drawn for dark backgrounds, since a light-background logo reads poorly on the dark sidebar. Covers the fallback too: leaving it unset, or setting it to an image that cannot be loaded, reuses the light logo rather than reverting to LiteLLM's own branding.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Documents the dark mode UI logo that BerriAI/litellm#37662 adds: the
UI_LOGO_PATH_DARKenv var and the matchinglogo_url_darktheme setting.docs/proxy/ui/ui_edit_logo.mdgets a "Dark Mode Logo" section plus the field in the existing API andproxy_config.yamlexamples.docs/proxy/config_settings.mdgets the env var reference row.The section leads on the fallback, since that is the part an admin is most likely to get wrong: leaving the dark logo unset, or setting one that cannot be loaded, reuses the light logo rather than reverting to LiteLLM's branding. Setting only the dark logo leaves light mode on the default, which is called out too.
Worth merging before the litellm PR, which cannot go green until this lands.
test-unit-documentation.ymlchecks out this repo'smainintodocs/my-websiteand runstests/documentation_tests/test_env_keys.py, socode-qualityanddocumentationboth fail there today withEnvironment variables read under ./litellm but mentioned nowhere in the docs: ['UI_LOGO_PATH_DARK']. Verified locally by symlinking this branch into that path and running the test, which fails onmainand passes here