chore: updates compat plugin docs

[sammaji]

Summary

Briefly explain the purpose of this PR and the problem it solves.

Changes

• What was changed and why
• Any notable design decisions or trade-offs

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

Describe the steps to validate this change. Include commands and expected outcomes.

# Core/Transports
go version
go test ./...

# UI
cd ui
pnpm i || npm i
pnpm test || npm test
pnpm build || npm run build

If adding new configs or environment variables, document them here.

Screenshots/Recordings

If UI changes, add before/after screenshots or short clips.

Breaking changes

• Yes
• No

If yes, describe impact and migration instructions.

Related issues

Link related issues and discussions. Example: Closes #123

Security considerations

Note any security implications (auth, secrets, PII, sandboxing, etc.).

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]

📝 Walkthrough

Walkthrough

Documentation updated to add an Unsupported Parameter Conversion compat transformation, a new client_config.compat.should_convert_params flag, a Gateway UI toggle under Settings → Compatibility, a Supported Parameters mapping (e.g., messages.role: developer → system), and header-based per-request enablement via x-bf-compat.

Changes

Cohort / File(s)

Summary

LiteLLM Compatibility Documentation docs/features/litellm-compat.mdx

Added "Unsupported Parameter Conversion" behavior; introduced client_config.compat.should_convert_params in configuration examples; updated Gateway UI path and toggle text to Settings → Compatibility and "Convert Unsupported Params Values"; added Supported Parameters conversion mappings (e.g., messages.role: developer → system); documented x-bf-compat header support including should_convert_params.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I nibble at keys and hop through docs,

converting roles with tiny flocks of fox,
"developer" hops to "system" with a twitch,
toggles flipped in compatibility's niche,
a rabbit's cheer for smoother API walks 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 3

❌ Failed checks (2 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The linked issue #123 concerns Files API support (file uploads, fine-tuning, RAG), which is unrelated to the compat plugin documentation updates described in the pull request changeset.	Either link the PR to relevant issues related to compat plugin documentation or remove the incorrect issue #123 reference.
Out of Scope Changes check	⚠️ Warning	The PR contains only documentation changes to compat plugin docs, which are entirely out of scope relative to the linked issue #123 (Files API support). This represents a fundamental mismatch between the PR's actual changes and its linked objectives.	Link the PR to issues related to compat plugin documentation updates, or if no such issues exist, remove the linked issue #123 reference and update the PR description accordingly.
Description check	❓ Inconclusive	The PR description lacks specific details about what was changed and why, leaving the Summary and Changes sections incomplete with placeholder text.	Fill in the Summary and Changes sections with specific details about the documentation updates (e.g., what new sections were added, what UI flows were updated, and why these changes were necessary).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'chore: updates compat plugin docs' is partially related to the changeset. It correctly identifies the PR as documentation-focused and mentions 'compat plugin,' but is vague about the specific documentation updates (new conversion mappings, Gateway UI flow changes, configuration examples, header overrides, etc.).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 04-14-chore_updates_compat_plugin_docs

---

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

[sammaji]

• chore: updates compat plugin docs #2698 👈 (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 #2698

[greptile-apps]

Confidence Score: 5/5

• Safe to merge — documentation-only changes with one minor wording nit.
• All findings are P2 style suggestions; no logic, data, or runtime concerns introduced.
• No files require special attention.

Important Files Changed

Filename	Overview
docs/features/litellm-compat.mdx	Documents new should_convert_params feature, updates navigation path, adds Supported Parameters table, Header Overrides section, and a UI screenshot; intro still says "two transformations" despite now listing four.
docs/media/compatibility-settings.png	New screenshot asset for the Compatibility Settings UI, referenced correctly in the MDX file.

_{Reviews (2): Last reviewed commit: "chore: updates compat plugin docs" | Re-trigger Greptile}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/features/litellm-compat.mdx`:
- Line 14: The intro sentence that currently reads "provides two
transformations" is now incorrect after adding the fourth bullet; update that
sentence in the intro paragraph to reflect the new count (e.g., change "provides
two transformations" to "provides four transformations" or to a non-numeric
phrase like "provides several transformations") so the statement matches the
list item "Unsupported Parameter Conversion" added as the fourth transformation.
- Around line 98-103: Update the wording in the "Convert Unsupported Params
Values" description: locate the list item for "Convert Unsupported Params
Values" and change the phrase "unsupported parameters values" to "unsupported
parameter values" so the sentence reads "converts unsupported parameter values
to their supported equivalents." Ensure the change is made in the doc string
under the Compatibility settings list.
- Around line 204-209: Change the phrase to use singular "compat plugin options"
and fix the ambiguous array example for the `x-bf-compat` header: update the
second bullet to read that `x-bf-compat: ["*"]` enables all compat plugin
options and replace the example `["<setting1>,<setting2>"]` with a clear array
of separate string elements like `["convert_text_to_chat",
"convert_chat_to_responses"]`, and ensure the available settings list
(`convert_text_to_chat`, `convert_chat_to_responses`, `should_drop_params`,
`should_convert_params`) remains included for reference.

🪄 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: 9f71f996-6b5b-4ff2-85e5-95434eec92d7

📥 Commits

Reviewing files that changed from the base of the PR and between 588e975 and 729f1c2.

⛔ Files ignored due to path filters (1)

• docs/media/compatibility-settings.png is excluded by !**/*.png

📒 Files selected for processing (1)

• docs/features/litellm-compat.mdx

[akshaydeo]

Merge activity

• Apr 14, 7:03 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Apr 14, 7:04 AM UTC: @akshaydeo merged this pull request with Graphite.