docs: clarify Ollama and OpenAI-compatible setup#441
Open
Beandon13 wants to merge 1 commit into
Open
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
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.
Summary
ollama/model prefix and the/v1base URL.OPENAI_BASE_URLwith theopenai/prefix.OPENAI_BASE_URLinstead ofOLLAMA_API_BASE.Why
Issue #428 calls out confusion around Ollama, OpenAI-compatible endpoints, and when provider prefixes are required. The updated docs make the routing explicit and give copy-pasteable examples for both normal local Ollama and generic OpenAI-compatible endpoints.
Test plan
python3 - <<'PY' ... docs sanity checks ... PYuvx --with mkdocs-material --with 'mkdocstrings[python]' mkdocs build --site-dir /tmp/cai-docs-build-428Note:
mkdocs build --strictstill fails on existing repository-wide warnings unrelated to this change; non-strict build succeeds.Fixes #428