-
Notifications
You must be signed in to change notification settings - Fork 213
Document OpenRouter setup for OpenAI-compatible models #1212
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
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Codex <[email protected]>
WalkthroughAdded OpenRouter as a new AI provider with documentation. The change includes adding an OpenRouter entry to the providers grid in the index and creating a new setup guide documenting two configuration methods using OpenAI-compatible endpoint and LiteLLM approaches. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks✅ Passed checks (3 passed)
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.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/ai-providers/openrouter.md (2)
17-23: Add explanatory text before Method 2's code block for consistency.Method 1 includes a brief explanation of what it does before the code block (line 9), but Method 2 lacks this context. Even if Method 2 is intentionally minimal, readers benefit from understanding what distinguishes it from Method 1.
Consider adding a description like: "Use the LiteLLM OpenRouter provider for more granular OpenRouter-specific model handling and routing features."
🔎 Suggested revision
### Method 2: LiteLLM OpenRouter provider +Use the LiteLLM OpenRouter provider for direct OpenRouter model identification and routing. + ```bash export OPENAI_API_BASE="https://openrouter.ai/api/v1" export OPENAI_API_KEY="sk-or-..." # your OpenRouter key holmes ask "hello" --model="openrouter/openai/gpt-4o-mini" --no-interactive</details> --- `25-25`: **Clarify which method the closing note applies to.** The note about swapping model IDs specifically shows the `openrouter/...` prefix format, which applies to Method 2. However, Method 1 users can also swap models (using the `openai/...` format without the prefix). Consider clarifying the scope or providing examples for both methods. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Organization UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between af8b2a58d9832cf146cac7d8580d21ed996ea3a6 and 696d35daf924be99fd734d6094b6d500bcce4b09. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `docs/ai-providers/index.md` (1 hunks) * `docs/ai-providers/openrouter.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>📓 Path-based instructions (1)</summary> <details> <summary>docs/**/*.md</summary> **📄 CodeRabbit inference engine (CLAUDE.md)** > When writing documentation in the docs/ directory, always add a blank line between headers/bold text and lists for proper MkDocs rendering Files: - `docs/ai-providers/index.md` - `docs/ai-providers/openrouter.md` </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)</summary> * GitHub Check: build (3.10) * GitHub Check: build (3.12) * GitHub Check: build (3.11) * GitHub Check: llm_evals * GitHub Check: build </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>docs/ai-providers/index.md (1)</summary><blockquote> `14-16`: **✅ OpenRouter entry properly added to providers grid.** The new OpenRouter entry is correctly formatted, alphabetically ordered between OpenAI-Compatible and Robusta AI, uses an appropriate icon (`:material-earth:`), and links to the new documentation page. Blank line spacing around the grid items complies with the MkDocs rendering requirements. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Summary
Testing
Codex Task
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.