Skip to content

Conversation

@aramaraju
Copy link
Contributor

Update Cody Guardrails Documentation with Known Limitations

This PR enhances the Cody Guardrails documentation by adding clarity around limitations and requirements.

Changes Made

Added Known Limitations Section:

  • Exact string matching requirement (10+ lines of code)
  • Coverage details: ~290,000 indexed open source repositories
  • BYOK limitation - requires Cody Gateway access
  • Platform support clarification (Web app, VS Code, JetBrains IDEs)

Updated Callout:

  • More specific about Enterprise + Cody Gateway requirements
  • Clearer messaging about BYOK incompatibility

Why These Changes

The previous documentation didn't clearly communicate important limitations that affect customer deployments, particularly around BYOK compatibility and the exact matching mechanism.

- Add Known Limitations section with 4 key points
- Clarify exact string matching requirement (10+ lines)
- Specify 290,000 indexed repositories coverage
- Note BYOK limitation and Cody Gateway requirement
- List supported platforms (Web app, VS Code, JetBrains IDEs)
- Update callout to be more specific about Enterprise + Gateway requirements
@vercel
Copy link

vercel bot commented Jun 9, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 17, 2025 9:30pm

Copy link
Contributor

@MaedahBatool MaedahBatool left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY, this looks good.

@MaedahBatool MaedahBatool changed the base branch from main to sg-next-jun25 June 24, 2025 02:05
@MaedahBatool MaedahBatool merged commit 279b6f0 into sg-next-jun25 Jun 24, 2025
7 checks passed
@MaedahBatool MaedahBatool deleted the guardrails-docs-update branch June 24, 2025 02:06
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