Fix encryption docs: stop steering users toward custom encryption when basic suffices#3325
Open
Connor Braa (cwlbraa) wants to merge 1 commit intomainfrom
Open
Fix encryption docs: stop steering users toward custom encryption when basic suffices#3325Connor Braa (cwlbraa) wants to merge 1 commit intomainfrom
Connor Braa (cwlbraa) wants to merge 1 commit intomainfrom
Conversation
…uffices - Move "selective field encryption" to the basic encryption row in the comparison table (LANGGRAPH_AES_JSON_KEYS already covers this use case) - Remove "Selective field encryption" bullet from custom encryption use cases - Add a prominent Warning box at the top of the custom encryption section discouraging its use when basic encryption meets the user's needs Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Connor Braa (cwlbraa)
requested review from
Florence Morris (fjmorris) and
Kathryn May (katmayb)
as code owners
Contributor
|
Mintlify preview ID generated: preview-cwlbra-1774553141-53c2668 |
Kathryn May (katmayb)
approved these changes
Mar 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
LANGGRAPH_AES_JSON_KEYSalready handles this use case, so listing it as a reason to use custom encryption was misleading<Warning>box at the top of the custom encryption section making it explicit that custom encryption should only be used when basic encryption doesn't meet your needsWhy
The doc was implicitly directing users toward custom encryption (more complex, requires implementing/maintaining handlers) for a use case (selective field encryption) that basic encryption already covers natively. This increases operational burden unnecessarily.
I've already jumped on one random customer call to Shepard folks in the right direction, this should prevent that from repeating.