Skip to content

docs: add Contributing to Guardrails section to Guardrail Providers sidebar - #24083

Merged
1 commit merged into
mainfrom
cursor/missing-guardrails-docs-143b
Mar 19, 2026
Merged

1 commit merged into
mainfrom
cursor/missing-guardrails-docs-143b

Conversation

@ghost

@ghost ghost commented Mar 19, 2026

Copy link
Copy Markdown

Relevant issues

Restores missing guardrails documentation links as reported by team.

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have Added testing in the tests/test_litellm/ directory, Adding at least 1 test is a hard requirement - see details (N/A - documentation-only change)
  • My PR passes all unit tests on make test-unit (verified docs build succeeds)
  • My PR's scope is as isolated as possible, it only solves 1 specific problem

Type

📖 Documentation

Changes

The guardrails contribution documentation existed but was only accessible from the "LiteLLM AI Gateway" tutorial sidebar. When users browsed the "Guardrail Providers" section (shown in integrationsSidebar), they couldn't see these important docs.

This PR adds the following to the "Guardrail Providers" category in integrationsSidebar:

  1. Contributing to Guardrails subcategory with links to:

    • Generic Guardrail API (integrate without PR)
    • Adding a New Guardrail Integration tutorial
    • Adding Guardrail Support to Endpoints
  2. Team Bring-Your-Own Guardrails link for the team BYOG workflow documentation

Now users browsing guardrail providers can easily discover how to contribute their own guardrails or set up team-based BYOG workflows.

Before

The "Guardrail Providers" section only showed provider-specific docs (Aim Security, Aporia, etc.) with no links to contribution guides.

After

The "Guardrail Providers" section now includes:

  • "Contributing to Guardrails" subcategory at the top
  • "Team Bring-Your-Own Guardrails" documentation link
  • All existing provider docs

Slack Thread

Open in Web Open in Cursor 

…idebar

- Add 'Contributing to Guardrails' category with links to:
  - Generic Guardrail API (integrate without PR)
  - Adding a New Guardrail Integration tutorial
  - Adding Guardrail Support to Endpoints

- Add 'Team Bring-Your-Own Guardrails' link for team BYOG workflow

These docs existed but were only accessible from the 'LiteLLM AI Gateway'
sidebar. Now they're also accessible when browsing the 'Guardrail Providers'
section.

Co-authored-by: Krish Dholakia <krrishdholakia@gmail.com>
@vercel

vercel Bot commented Mar 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
litellm Ready Ready Preview, Comment Mar 19, 2026 4:49am

Request Review

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@codspeed

codspeed Bot commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

Merging this PR will not alter performance

✅ 16 untouched benchmarks


Comparing cursor/missing-guardrails-docs-143b (df38fbc) with main (0ecced9)

Open in CodSpeed

@ghost
ghost marked this pull request as ready for review March 19, 2026 04:54
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@ghost
ghost merged commit 547a731 into main Mar 19, 2026
15 of 38 checks passed
@greptile-apps

greptile-apps Bot commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This is a documentation-only PR that restores discoverability of guardrail contribution guides by adding them to the integrationsSidebar "Guardrail Providers" category in sidebars.js. Previously these pages were only reachable from the "LiteLLM AI Gateway" tutorial sidebar.

  • Adds a "Contributing to Guardrails" subcategory containing adding_provider/generic_guardrail_api, adding_provider/simple_guardrail_tutorial, and adding_provider/adding_guardrail_support — all three files exist on disk.
  • Adds a "Team Bring-Your-Own Guardrails" doc entry pointing to proxy/guardrails/team_based_guardrails — file exists on disk.
  • No code, tests, or runtime behaviour is changed; the modification is confined to the Docusaurus sidebar configuration.

Confidence Score: 5/5

  • This PR is safe to merge — it is a purely additive, documentation-only sidebar configuration change.
  • All four referenced documentation files already exist in the repository. The added sidebar entries follow the existing Docusaurus patterns used throughout the file. No runtime code, tests, or APIs are touched.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/my-website/sidebars.js Adds "Contributing to Guardrails" subcategory and "Team Bring-Your-Own Guardrails" link to the integrationsSidebar's "Guardrail Providers" section; all referenced doc files exist and the structure is valid.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[integrationsSidebar] --> B[Guardrail Providers]
    B --> C[Contributing to Guardrails\n**NEW**]
    C --> C1[Generic Guardrail API\nadding_provider/generic_guardrail_api]
    C --> C2[Adding a New Guardrail Integration\nadding_provider/simple_guardrail_tutorial]
    C --> C3[Adding Guardrail Support to Endpoints\nadding_provider/adding_guardrail_support]
    B --> D[Team Bring-Your-Own Guardrails\n**NEW** proxy/guardrails/team_based_guardrails]
    B --> E[Provider Docs\nqualifire, aim_security, aporia, ...\nsorted alphabetically]
Loading

Last reviewed commit: "docs: add Contributi..."

@ishaan-berri
ishaan-berri deleted the cursor/missing-guardrails-docs-143b branch March 26, 2026 22:29
fzowl pushed a commit to fzowl/litellm that referenced this pull request Jun 24, 2026
…ls-docs-143b

docs: add Contributing to Guardrails section to Guardrail Providers sidebar
This pull request was closed.
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