chore: update provider management docs - #3953
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (20)
📝 WalkthroughWalkthroughThis PR consolidates API provider key management documentation across 21 AI provider documentation files. Inline curl examples in API setup tabs are removed and replaced with a single reference link to centralized "Provider Keys Management" API documentation, eliminating duplication. ChangesProvider documentation API examples consolidation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
d6da325 to
4786a2b
Compare
Confidence Score: 5/5Documentation-only change with no impact on runtime behavior, configuration schema, or API contracts. Every modification is a uniform doc-only substitution — removing a local curl snippet and pointing to a centralized reference page. No code, config, or schema is touched, and the replacement link is consistent across all 20 files. No files require special attention. Important Files Changed
Reviews (4): Last reviewed commit: "chore: update provider management docs" | Re-trigger Greptile |
816bc36 to
a8d28dc
Compare
82403ee to
a6b4820
Compare
a8d28dc to
c4cac97
Compare
a6b4820 to
48158ed
Compare
Merge activity
|
## Summary Replaces inline `curl` code snippets in the "API" tab of every supported provider's configuration section with a reference link to the centralized [Provider Keys Management](https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider) API documentation page. ## Changes - Removed provider-specific `curl` examples from the API tab across all supported provider docs (Anthropic, Cerebras, Cohere, ElevenLabs, Fireworks, Gemini, Groq, Hugging Face, Mistral, Nebius, Ollama, OpenAI, OpenRouter, Parasail, Perplexity, Replicate, Runway, SGLang, vLLM, xAI). - Replaced each removed snippet with a short prose reference pointing to the shared API reference for provider key creation, reducing duplication and ensuring the docs stay in sync with the API spec going forward. ## Type of change - [ ] Bug fix - [ ] Feature - [ ] Refactor - [x] Documentation - [ ] Chore/CI ## Affected areas - [ ] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [ ] Plugins - [ ] UI (React) - [x] Docs ## How to test Review the rendered documentation to confirm: 1. The "API" tab in each provider's configuration section displays the reference link instead of a `curl` snippet. 2. The link correctly navigates to `https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider`. ## Breaking changes - [ ] Yes - [x] No ## Related issues ## Security considerations None. No secrets, auth changes, or runtime behavior affected. ## Checklist - [x] I read `docs/contributing/README.md` and followed the guidelines - [x] I added/updated tests where appropriate - [x] I updated documentation where needed - [x] I verified builds succeed (Go and UI) - [x] I verified the CI pipeline passes locally if applicable <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated documentation for all supported AI providers to streamline API key configuration. Removed inline curl examples and unified instructions by directing users to the centralized Provider Keys Management API documentation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary Replaces inline `curl` code snippets in the "API" tab of every supported provider's configuration section with a reference link to the centralized [Provider Keys Management](https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider) API documentation page. ## Changes - Removed provider-specific `curl` examples from the API tab across all supported provider docs (Anthropic, Cerebras, Cohere, ElevenLabs, Fireworks, Gemini, Groq, Hugging Face, Mistral, Nebius, Ollama, OpenAI, OpenRouter, Parasail, Perplexity, Replicate, Runway, SGLang, vLLM, xAI). - Replaced each removed snippet with a short prose reference pointing to the shared API reference for provider key creation, reducing duplication and ensuring the docs stay in sync with the API spec going forward. ## Type of change - [ ] Bug fix - [ ] Feature - [ ] Refactor - [x] Documentation - [ ] Chore/CI ## Affected areas - [ ] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [ ] Plugins - [ ] UI (React) - [x] Docs ## How to test Review the rendered documentation to confirm: 1. The "API" tab in each provider's configuration section displays the reference link instead of a `curl` snippet. 2. The link correctly navigates to `https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider`. ## Breaking changes - [ ] Yes - [x] No ## Related issues ## Security considerations None. No secrets, auth changes, or runtime behavior affected. ## Checklist - [x] I read `docs/contributing/README.md` and followed the guidelines - [x] I added/updated tests where appropriate - [x] I updated documentation where needed - [x] I verified builds succeed (Go and UI) - [x] I verified the CI pipeline passes locally if applicable <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated documentation for all supported AI providers to streamline API key configuration. Removed inline curl examples and unified instructions by directing users to the centralized Provider Keys Management API documentation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
## Summary Replaces inline `curl` code snippets in the "API" tab of every supported provider's configuration section with a reference link to the centralized [Provider Keys Management](https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider) API documentation page. ## Changes - Removed provider-specific `curl` examples from the API tab across all supported provider docs (Anthropic, Cerebras, Cohere, ElevenLabs, Fireworks, Gemini, Groq, Hugging Face, Mistral, Nebius, Ollama, OpenAI, OpenRouter, Parasail, Perplexity, Replicate, Runway, SGLang, vLLM, xAI). - Replaced each removed snippet with a short prose reference pointing to the shared API reference for provider key creation, reducing duplication and ensuring the docs stay in sync with the API spec going forward. ## Type of change - [ ] Bug fix - [ ] Feature - [ ] Refactor - [x] Documentation - [ ] Chore/CI ## Affected areas - [ ] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [ ] Plugins - [ ] UI (React) - [x] Docs ## How to test Review the rendered documentation to confirm: 1. The "API" tab in each provider's configuration section displays the reference link instead of a `curl` snippet. 2. The link correctly navigates to `https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider`. ## Breaking changes - [ ] Yes - [x] No ## Related issues ## Security considerations None. No secrets, auth changes, or runtime behavior affected. ## Checklist - [x] I read `docs/contributing/README.md` and followed the guidelines - [x] I added/updated tests where appropriate - [x] I updated documentation where needed - [x] I verified builds succeed (Go and UI) - [x] I verified the CI pipeline passes locally if applicable <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated documentation for all supported AI providers to streamline API key configuration. Removed inline curl examples and unified instructions by directing users to the centralized Provider Keys Management API documentation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->

Summary
Replaces inline
curlcode snippets in the "API" tab of every supported provider's configuration section with a reference link to the centralized Provider Keys Management API documentation page.Changes
curlexamples from the API tab across all supported provider docs (Anthropic, Cerebras, Cohere, ElevenLabs, Fireworks, Gemini, Groq, Hugging Face, Mistral, Nebius, Ollama, OpenAI, OpenRouter, Parasail, Perplexity, Replicate, Runway, SGLang, vLLM, xAI).Type of change
Affected areas
How to test
Review the rendered documentation to confirm:
curlsnippet.https://docs.getbifrost.ai/api-reference/providers/create-a-key-for-a-provider.Breaking changes
Related issues
Security considerations
None. No secrets, auth changes, or runtime behavior affected.
Checklist
docs/contributing/README.mdand followed the guidelinesSummary by CodeRabbit