docs: fixed virtual key definition in routing docs

[akshaydeo]

Summary

Update the virtual keys API schema in the documentation to use the new structure with provider_configs and allowed_keys instead of the deprecated keys and key_id fields.

Changes

• Updated the virtual keys API example in the routing documentation
• Changed the structure from using keys array with key_id to using provider_configs array with allowed_keys array
• This aligns the documentation with the current API implementation

Type of change

• Bug fix
• Feature
• Refactor
• Documentation
• Chore/CI

Affected areas

• Core (Go)
• Transports (HTTP)
• Providers/Integrations
• Plugins
• UI (Next.js)
• Docs

How to test

Verify that the documentation matches the current API implementation:

# Test the API with the new structure
curl -X PUT http://localhost:8080/api/governance/virtual-keys/{vk_id} \
-H "Content-Type: application/json" \
-d '{
  "virtual_keys": [
    {
      "id": "vk-prod-main",
      "provider_configs": [
        {
          "allowed_keys": [
            "key-prod-001"
          ]
        }
      ]
    }
  ]
}'

Breaking changes

• Yes
• No

Related issues

Updates documentation to match current API implementation.

Security considerations

No security implications as this is a documentation update only.

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

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated Virtual Keys API examples to the new provider-based payload format (provider configs with allowed keys).
  • Added a comprehensive "Overview" documentation page introducing the Bifrost AI Gateway, covering architecture, features, quickstarts, provider support, and integrations.
  • Added an "Overview" navigation group to the Documentation tab for easier access to the new overview page.

Walkthrough

Documentation updates: changed Virtual Keys API payload examples (replace keys with provider_configs, key_id with provider + allowed_keys array), added a new "Overview" docs group in docs/docs.json, and added a comprehensive docs/overview.mdx overview page for the Bifrost AI Gateway.

Changes

Cohort / File(s)	Summary
Governance / Routing doc docs/features/governance/routing.mdx	Updated API examples: replaced top-level keys with provider_configs; each entry now uses provider and allowed_keys (array) instead of key_id.
Documentation manifest docs/docs.json	Added new Documentation group "Overview" with icon book-open-cover and page overview.
Overview page docs/overview.mdx	Added new comprehensive overview MDX describing Bifrost AI Gateway, architecture, features, quickstarts, provider matrix, and integration cards (+~242 lines).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 I hopped through docs with nimble paws,
Swapped keys for configs—no faux pas,
Providers listed, allowed keys in line,
A tidy gateway, humming fine. 🥕✨

🚥 Pre-merge checks | ✅ 4 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The PR description states it 'Updates documentation to match current API implementation' with no related issues linked, but issue #123 about Files API Support is unrelated to virtual key documentation updates.	Either link relevant issues that relate to this virtual key documentation change or clarify if this PR should not reference issue #123 at all.
Out of Scope Changes check	⚠️ Warning	The PR updates virtual key API documentation structure, but the only linked issue #123 concerns Files API support for providers—a fundamentally different feature scope.	Verify if issue #123 is correctly linked or if the PR should reference different issues related to virtual key schema changes.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: fixing the virtual key definition in routing documentation.
Description check	✅ Passed	The PR description follows the template structure with all major sections completed including summary, changes, type, affected areas, testing steps, breaking changes, and checklist.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

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

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 02-13-docs_fixed_virtual_key_definition_in_routing_docs

---

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

[akshaydeo]

• docs: fixed virtual key definition in routing docs #1639 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

🧪 Test Suite Available

This PR can be tested by a repository admin.

Run tests for PR #1639

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/features/governance/routing.mdx`:
- Around line 290-295: The example config under provider_configs is missing the
required "provider" field; update the config.json example so each object in
provider_configs includes a "provider" key (alongside the existing
"allowed_keys") to match the schema and other examples; locate the
provider_configs array in the routing.mdx example and add the appropriate
provider identifier string to each entry so the example mirrors helm values/test
configs and validates against the schema.