Skip to content

Commit 279b6f0

Browse files
authored
docs: Update Cody Guardrails documentation with known limitations (#1181)
## 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.
1 parent 25e290f commit 279b6f0

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/cody/enterprise/features.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Site administrators can set the duration of access tokens for users connecting C
1010

1111
## Guardrails
1212

13-
<Callout type= "note">Guardrails for public code is currently in Beta and is supported with VS Code, JetBrains IDEs extensions and Sourcegraph Web app.</Callout>
13+
<Callout type= "note">Guardrails for public code is only supported on VS Code, JetBrains IDEs extension, and Sourcegraph Web app for Cody Enterprise customers using [Cody Gateway](https://sourcegraph.com/docs/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway). It is not supported for any BYOK (Bring Your Own Key) deployments. </Callout>
1414

1515
Open source attribution guardrails for public code, commonly called copyright guardrails, reduce the exposure to copyrighted code. This involves implementing a verification mechanism within Cody to ensure that any code generated by the platform does not replicate open source code.
1616

@@ -22,6 +22,12 @@ Guardrails don't differentiate between license types. It matches any code snippe
2222

2323
You can `enforce` a Guardrails check to prevent any matching code from being shown to the user. To do so, site admins need to add `"attribution.mode": "enforced"` in the **Site configuration** setting. This will configure the settings for Cody IDE extensions VS Code (v1.82+) or JetBrains (v7.82+) accordingly and will enforce not to display code until attribution checks have finished.
2424

25+
### Known Limitations
26+
1. Guardrails work through an exact string match across ten or more lines, which means extra comments or name changes may not trigger the check
27+
2. The strings are compared against around **290,000** indexed open source repositories, consisting of all license types, including permissive and non-permissive licenses
28+
3. Guardrails requires access to the Cody Gateway, which means it's not supported for any customers using BYOK (Bring Your Own Key)
29+
4. Guardrails is only supported on the Sourcegraph Web app, and the IDE extensions in VS Code, JetBrains IDEs, for chat and autocomplete
30+
2531
## Admin controls
2632

2733
<Callout type="note">Admin controls are supported with VS Code and JetBrains IDE extension.</Callout>

0 commit comments

Comments
 (0)