docs: document Windows and LiteLLM provider setup#334
Open
KairosMarco wants to merge 2 commits 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
This PR adds a small quickstart clarification for local PageIndex setup:
Activate.ps1execution-policy workaround using only the current shell session,--model.Why
New users can currently follow the README successfully on Unix-like shells, but Windows users may hit PowerShell's script execution policy when activating
.venv.The README also mentions multi-LLM support through LiteLLM, but the quickstart only shows
OPENAI_API_KEY. Adding a provider-key example makes it clearer that users can run PageIndex with other LiteLLM-supported providers without changing code.Changes
python3 -m venv .venvand activation.Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypassas a current-session workaround for blocked virtualenv activation.DASHSCOPE_API_KEYand--model dashscope/qwen-plus.Validation
git diff --checkLocal result: