Skip to content

docs: Update Cody Guardrails documentation with known limitations #1181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

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
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

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.

1 participant