Skip to content

chore: update provider management docs - #3953

Merged
akshaydeo merged 6 commits into
devfrom
06-01-chore_update_provider_management_docs
Jun 2, 2026
Merged

chore: update provider management docs#3953
akshaydeo merged 6 commits into
devfrom
06-01-chore_update_provider_management_docs

Conversation

@sammaji

@sammaji sammaji commented Jun 1, 2026

Copy link
Copy Markdown
Member

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 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
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • 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
  • No

Related issues

Security considerations

None. No secrets, auth changes, or runtime behavior affected.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

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.

@coderabbitai

coderabbitai Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 32ff35ab-cb1f-48d0-a58b-7ed71a1cc915

📥 Commits

Reviewing files that changed from the base of the PR and between 48158ed and c4cac97.

📒 Files selected for processing (20)
  • docs/providers/supported-providers/anthropic.mdx
  • docs/providers/supported-providers/cerebras.mdx
  • docs/providers/supported-providers/cohere.mdx
  • docs/providers/supported-providers/elevenlabs.mdx
  • docs/providers/supported-providers/fireworks.mdx
  • docs/providers/supported-providers/gemini.mdx
  • docs/providers/supported-providers/groq.mdx
  • docs/providers/supported-providers/huggingface.mdx
  • docs/providers/supported-providers/mistral.mdx
  • docs/providers/supported-providers/nebius.mdx
  • docs/providers/supported-providers/ollama.mdx
  • docs/providers/supported-providers/openai.mdx
  • docs/providers/supported-providers/openrouter.mdx
  • docs/providers/supported-providers/parasail.mdx
  • docs/providers/supported-providers/perplexity.mdx
  • docs/providers/supported-providers/replicate.mdx
  • docs/providers/supported-providers/runway.mdx
  • docs/providers/supported-providers/sgl.mdx
  • docs/providers/supported-providers/vllm.mdx
  • docs/providers/supported-providers/xai.mdx

📝 Walkthrough

Walkthrough

This 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.

Changes

Provider documentation API examples consolidation

Layer / File(s) Summary
Consolidate API setup examples across all provider documentation
docs/providers/supported-providers/anthropic.mdx, cerebras.mdx, cohere.mdx, elevenlabs.mdx, fireworks.mdx, gemini.mdx, groq.mdx, huggingface.mdx, mistral.mdx, nebius.mdx, ollama.mdx, openai.mdx, openrouter.mdx, parasail.mdx, perplexity.mdx, replicate.mdx, runway.mdx, sgl.mdx, vllm.mdx, xai.mdx
Inline curl request examples for creating provider keys are removed from the API tab in each of the 20 provider documentation files and replaced with a reference link to the shared "Provider Keys Management" API documentation. Gemini documentation also includes a minor formatting adjustment at the end of the "System Instruction Integration" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • maximhq/bifrost#3808: Adds inline setup/configuration sections (curl, config.json, Web UI, Go SDK) to provider documentation, representing the inverse change pattern to this PR's consolidation approach.

Suggested reviewers

  • danpiths
  • Pratham-Mishra04
  • akshaydeo

Poem

🐰 Twenty providers, one unified way,
Curl examples consolidated, hooray!
From duplicate scripts to links so clear,
Documentation's streamlined here!
Simplicity wins—no more to say! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: update provider management docs' is partially related to the changeset but lacks specificity—it doesn't convey the main change (replacing curl snippets with documentation links).
Description check ✅ Passed The PR description is comprehensive and well-structured, covering all major template sections with clear explanations of changes, testing approach, and impact assessment.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 06-01-chore_update_provider_management_docs

Comment @coderabbitai help to get the list of available commands and usage tips.

@sammaji sammaji mentioned this pull request Jun 1, 2026
18 tasks
@sammaji
sammaji force-pushed the 06-01-chore_update_provider_management_docs branch from d6da325 to 4786a2b Compare June 1, 2026 13:42
@sammaji
sammaji marked this pull request as ready for review June 1, 2026 13:42
@greptile-apps

greptile-apps Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

Documentation-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

Filename Overview
docs/providers/supported-providers/anthropic.mdx API tab curl snippet replaced with reference link to centralized Provider Keys Management docs — consistent with all other changed files.
docs/providers/supported-providers/gemini.mdx API tab curl snippet replaced with reference link; also adds trailing newline to the final Accordion tag.
docs/providers/supported-providers/ollama.mdx API tab curl snippet (which included ollama_key_config.url) replaced with reference link — provider-specific fields are covered in the linked API reference page.
docs/providers/supported-providers/vllm.mdx API tab curl snippet (which included vllm_key_config.url and model_name) replaced with reference link — same pattern as ollama and sgl.
docs/providers/supported-providers/openai.mdx API tab curl snippet (including openai_config.disable_store) replaced with reference link to centralized docs.

Reviews (4): Last reviewed commit: "chore: update provider management docs" | Re-trigger Greptile

Comment thread docs/providers/supported-providers/ollama.mdx
Comment thread docs/providers/supported-providers/anthropic.mdx
@sammaji
sammaji force-pushed the 06-01-chore_update_provider_management_docs branch 2 times, most recently from 816bc36 to a8d28dc Compare June 2, 2026 05:26
@sammaji
sammaji force-pushed the 05-29-chore_updated_docs_for_extra_params_passthrough branch from 82403ee to a6b4820 Compare June 2, 2026 05:26
@sammaji
sammaji force-pushed the 06-01-chore_update_provider_management_docs branch from a8d28dc to c4cac97 Compare June 2, 2026 09:11
@sammaji
sammaji force-pushed the 05-29-chore_updated_docs_for_extra_params_passthrough branch from a6b4820 to 48158ed Compare June 2, 2026 09:11

akshaydeo commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Merge activity

  • Jun 2, 4:44 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jun 2, 4:49 PM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo
akshaydeo changed the base branch from 05-29-chore_updated_docs_for_extra_params_passthrough to graphite-base/3953 June 2, 2026 16:48
@akshaydeo
akshaydeo changed the base branch from graphite-base/3953 to dev June 2, 2026 16:48
@akshaydeo
akshaydeo requested a review from a team as a code owner June 2, 2026 16:48
@akshaydeo
akshaydeo merged commit c87341e into dev Jun 2, 2026
13 checks passed
@akshaydeo
akshaydeo deleted the 06-01-chore_update_provider_management_docs branch June 2, 2026 16:49
akshaydeo pushed a commit that referenced this pull request Jun 2, 2026
## 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 -->
akshaydeo pushed a commit that referenced this pull request Jun 4, 2026
## 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 -->
akshaydeo pushed a commit that referenced this pull request Jun 7, 2026
## 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 -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants