fixes config docs - #3722
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughUpdates clarify gateway config persistence and DB reconciliation semantics, simplify a schema note and wrapping, and substantially expand and reorganize test-harness coverage tables, provider feature rows, modality matrices, passthrough surface details, and transport-route categories. ChangesGateway Setup Documentation
Test Harness Coverage
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
|
akshaydeo
marked this pull request as ready for review
May 25, 2026 06:26
Contributor
Confidence Score: 5/5Documentation-only change that clarifies existing behavior; no code paths are modified. The hash-based reconciliation description in setting-up.mdx aligns with the actual Go implementation: per-entity ConfigHash fields exist on every table, UI updates preserve the original ConfigHash (so re-applying an unchanged config.json leaves DB edits intact), and a changed config.json entity triggers an overwrite. The previous contradictions and orphaned heading flagged in earlier review threads are resolved. The test-harness doc updates are factual expansions with no logic to break. No files require special attention. Important Files Changed
Reviews (4): Last reviewed commit: "fixes config docs" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/quickstart/gateway/setting-up.mdx (1)
145-160: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winUse required Mintlify tabs for configuration modes.
This section should be presented with Web UI / API / config.json tabs instead of plain headings to comply with docs standards.
As per coding guidelines "
docs/**/*.mdx: Mintlify MDX documentation must have Web UI / API / config.json tabs; validate config.json examples against transports/config.schema.json".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/quickstart/gateway/setting-up.mdx` around lines 145 - 160, Replace the plain headings "Mode 1: Web UI Configuration" and "Mode 2: File-based Configuration" with Mintlify tab blocks labeled "Web UI", "API", and "config.json" so the section uses required tabs; move the UI content (including the image and the two bullet cases) into the "Web UI" tab, add an "API" tab placeholder or content if applicable, and place the file-based configuration instructions plus the example config.json into the "config.json" tab; ensure the config.json example shown in the "config.json" tab is validated/updated to conform to transports/config.schema.json.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/quickstart/gateway/setting-up.mdx`:
- Around line 134-143: The page contains conflicting descriptions of persistence
for config.json: one section says the DB ignores config.json configurations,
while the shown hunk explains entities are stored by content-based hash and that
editing config.json with a changed hash will overwrite DB entries; reconcile by
updating the contradictory sentence (referencing "config.json" and
"content-based hash") to clearly state the precedence rules — e.g., that on
first load entities from config.json are written to the DB with a content hash,
subsequent UI/API changes persist to the DB and are preserved unless config.json
is edited such that the content-based hash changes (in which case the file
definition overwrites the DB) — and ensure the page consistently uses the terms
"config.json", "content-based hash", and "database" across both places.
---
Outside diff comments:
In `@docs/quickstart/gateway/setting-up.mdx`:
- Around line 145-160: Replace the plain headings "Mode 1: Web UI Configuration"
and "Mode 2: File-based Configuration" with Mintlify tab blocks labeled "Web
UI", "API", and "config.json" so the section uses required tabs; move the UI
content (including the image and the two bullet cases) into the "Web UI" tab,
add an "API" tab placeholder or content if applicable, and place the file-based
configuration instructions plus the example config.json into the "config.json"
tab; ensure the config.json example shown in the "config.json" tab is
validated/updated to conform to transports/config.schema.json.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5d0c8c35-e412-43f4-9498-803386e9a189
📒 Files selected for processing (1)
docs/quickstart/gateway/setting-up.mdx
akshaydeo
force-pushed
the
05-25-fixes_config_docs
branch
from
May 25, 2026 07:09
a1b15ad to
9224437
Compare
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/quickstart/gateway/setting-up.mdx (1)
145-205: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winAdd required Mintlify tabs for configuration flows.
This section documents Web UI and file-based config behavior, but it is not structured with the required Web UI / API / config.json tabs. Please convert this section into tabbed MDX to match docs standards.
As per coding guidelines "
docs/**/*.mdx: Mintlify MDX documentation must have Web UI / API / config.json tabs; validate config.json examples against transports/config.schema.json".🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/quickstart/gateway/setting-up.mdx` around lines 145 - 205, Convert the "Mode 1: Web UI Configuration" / "Mode 2: File-based Configuration" section into Mintlify tabbed MDX with three tabs labeled "Web UI", "API", and "config.json" (move the UI description and image under "Web UI", any API runtime/behavior notes under "API", and the file-based example and bullet points under "config.json"); ensure the config.json code block matches the transports/config.schema.json schema (validate keys, types, and model names) and update any text to reference the appropriate tab where it originally lived (use the existing headings "Mode 1: Web UI Configuration" and "Mode 2: File-based Configuration" to locate content).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/quickstart/gateway/setting-up.mdx`:
- Around line 145-205: Convert the "Mode 1: Web UI Configuration" / "Mode 2:
File-based Configuration" section into Mintlify tabbed MDX with three tabs
labeled "Web UI", "API", and "config.json" (move the UI description and image
under "Web UI", any API runtime/behavior notes under "API", and the file-based
example and bullet points under "config.json"); ensure the config.json code
block matches the transports/config.schema.json schema (validate keys, types,
and model names) and update any text to reference the appropriate tab where it
originally lived (use the existing headings "Mode 1: Web UI Configuration" and
"Mode 2: File-based Configuration" to locate content).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 20078acd-4a37-4d51-bf7d-ffcbb6898a83
📒 Files selected for processing (1)
docs/quickstart/gateway/setting-up.mdx
akshaydeo
force-pushed
the
05-25-fixes_config_docs
branch
from
May 25, 2026 07:16
9224437 to
e03525c
Compare
akshaydeo
force-pushed
the
05-25-fixes_config_docs
branch
from
May 25, 2026 08:07
e03525c to
4621a71
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/providers/test-harness-coverage.mdx`:
- Line 156: The docs row for "Adaptive thinking (Opus 4.7 via `/v1/chat`)"
incorrectly claims service_tier, performanceConfig (latency: "optimized"), and
request metadata are exercised; update either the docs or the harness: either
change docs/providers/test-harness-coverage.mdx to remove the ✅s (and correct
the endpoint string) to match the existing test in
tests/e2e/api/collections/provider-harness.json (the "Adaptive thinking (Opus
4.7)" entry with model "claude-opus-4-7" and url
"{{baseUrl}}/anthropic/v1/messages"), or add new Opus 4.7 harness cases in
provider-harness.json that send/assert service_tier: "auto", performanceConfig:
{ latency: "optimized" }, and any request metadata fields so the docs are
accurate.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1a35813c-f44d-4495-aba6-74d9fb239307
📒 Files selected for processing (2)
docs/providers/test-harness-coverage.mdxdocs/quickstart/gateway/setting-up.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/quickstart/gateway/setting-up.mdx
| | PDF input (URLs auto-fetched + inlined) | ✅ | | ||
| | Citations on document blocks | ✅ | | ||
| | Extended thinking (`thinking.budget_tokens`) | ✅ | | ||
| | Adaptive thinking (Opus 4.7 via `/v1/chat`) | ✅ | |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify Anthropic features documented on lines 156, 164-166 exist in the harness
echo "=== Searching for Opus 4.7 adaptive thinking ==="
rg -i "adaptive" tests/e2e/api/collections/provider-harness.json -A2 -B2 | head -20
echo "=== Searching for service tier in Anthropic/Bedrock sections ==="
rg -i "service.?tier" tests/e2e/api/collections/provider-harness.json -C2 | head -20
echo "=== Searching for performance config ==="
rg -i "performance|latency.*optimized" tests/e2e/api/collections/provider-harness.json -C2 | head -20
echo "=== Searching for request metadata ==="
rg -i "metadata" tests/e2e/api/collections/provider-harness.json -C2 | head -20Repository: maximhq/bifrost
Length of output: 23237
Fix Anthropic “Opus 4.7” harness coverage row: service tier / perf config / request metadata aren’t exercised
In docs/providers/test-harness-coverage.mdx (lines 156, 164–166), the ✅ entries claim service tier (auto), performance config (latency: optimized), and request metadata for Adaptive thinking (Opus 4.7 via /v1/chat). However, tests/e2e/api/collections/provider-harness.json’s Opus 4.7 adaptive-thinking test ("Adaptive thinking (Opus 4.7)", model claude-opus-4-7, url {{baseUrl}}/anthropic/v1/messages) only sets thinking: { "type": "adaptive" } plus messages and does not include service_tier, performanceConfig/latency: "optimized", or request-metadata fields.
Update the docs to match the harness (including the endpoint), or add Opus 4.7 harness cases that actually send/assert those fields.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/providers/test-harness-coverage.mdx` at line 156, The docs row for
"Adaptive thinking (Opus 4.7 via `/v1/chat`)" incorrectly claims service_tier,
performanceConfig (latency: "optimized"), and request metadata are exercised;
update either the docs or the harness: either change
docs/providers/test-harness-coverage.mdx to remove the ✅s (and correct the
endpoint string) to match the existing test in
tests/e2e/api/collections/provider-harness.json (the "Adaptive thinking (Opus
4.7)" entry with model "claude-opus-4-7" and url
"{{baseUrl}}/anthropic/v1/messages"), or add new Opus 4.7 harness cases in
provider-harness.json that send/assert service_tier: "auto", performanceConfig:
{ latency: "optimized" }, and any request metadata fields so the docs are
accurate.
Contributor
Author
Merge activity
|
This was referenced Jun 11, 2026
2 tasks
akhsaul
pushed a commit
to akhsaul/bifrost
that referenced
this pull request
Aug 27, 2026
## Summary Clarifies how `config.json` and database state interact in Bifrost's two configuration modes, replacing the previous misleading statement that the two approaches cannot be used simultaneously. ## Changes - Added an explanation of the content-based hash mechanism: entities defined in `config.json` are stored with a hash on first load, and subsequent UI/API changes persist to the database without being overwritten by re-applying the same `config.json` - Removed the inaccurate note stating the two configuration modes cannot be used simultaneously - Removed the outdated advanced-user warning that modifying `config.json` after initial bootstrap has no effect when `config_store` is enabled, replacing it with the more accurate hash-based behavior description ## 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 updated `docs/quickstart/gateway/setting-up.mdx` and verify the config/database interaction explanation is accurate against the actual Bifrost bootstrap and hash-check behavior. ## Breaking changes - [ ] Yes - [x] No ## Related issues ## Security considerations None. ## Checklist - [ ] I read `docs/contributing/README.md` and followed the guidelines - [ ] I added/updated tests where appropriate - [x] I updated documentation where needed - [ ] I verified builds succeed (Go and UI) - [ ] I verified the CI pipeline passes locally if applicable
occcat
pushed a commit
to occcat/bifrost
that referenced
this pull request
Sep 2, 2026
## Summary Clarifies how `config.json` and database state interact in Bifrost's two configuration modes, replacing the previous misleading statement that the two approaches cannot be used simultaneously. ## Changes - Added an explanation of the content-based hash mechanism: entities defined in `config.json` are stored with a hash on first load, and subsequent UI/API changes persist to the database without being overwritten by re-applying the same `config.json` - Removed the inaccurate note stating the two configuration modes cannot be used simultaneously - Removed the outdated advanced-user warning that modifying `config.json` after initial bootstrap has no effect when `config_store` is enabled, replacing it with the more accurate hash-based behavior description ## 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 updated `docs/quickstart/gateway/setting-up.mdx` and verify the config/database interaction explanation is accurate against the actual Bifrost bootstrap and hash-check behavior. ## Breaking changes - [ ] Yes - [x] No ## Related issues ## Security considerations None. ## Checklist - [ ] I read `docs/contributing/README.md` and followed the guidelines - [ ] I added/updated tests where appropriate - [x] I updated documentation where needed - [ ] I verified builds succeed (Go and UI) - [ ] I verified the CI pipeline passes locally if applicable
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
2 participants
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
Clarifies how
config.jsonand database state interact in Bifrost's two configuration modes, replacing the previous misleading statement that the two approaches cannot be used simultaneously.Changes
config.jsonare stored with a hash on first load, and subsequent UI/API changes persist to the database without being overwritten by re-applying the sameconfig.jsonconfig.jsonafter initial bootstrap has no effect whenconfig_storeis enabled, replacing it with the more accurate hash-based behavior descriptionType of change
Affected areas
How to test
Review the updated
docs/quickstart/gateway/setting-up.mdxand verify the config/database interaction explanation is accurate against the actual Bifrost bootstrap and hash-check behavior.Breaking changes
Related issues
Security considerations
None.
Checklist
docs/contributing/README.mdand followed the guidelines