Add when-to-choose-redis guide to AI documentation#2967
Add when-to-choose-redis guide to AI documentation#2967mich-elle-luna wants to merge 3 commits intomainfrom
Conversation
- Add comprehensive guide for choosing Redis over alternatives (Pinecone, MongoDB, Postgres) - Follow Google technical writing style guidelines - Remove bold formatting for cleaner, more readable content - Include decision matrix and selection criteria - Add practical examples for each comparison - Use proper Hugo relref syntax for internal links
🛡️ Jit Security Scan Results
✅ No security findings were detected in this PR
Security scan by Jit
|
andy-stark-redis
left a comment
andy-stark-redis
left a comment
There was a problem hiding this comment.
Nothing wrong, but just a few suggestions to consider. Otherwise, LGTM.
| @@ -0,0 +1,72 @@ | |||
| --- | |||
There was a problem hiding this comment.
Should this be in the AI/Search section? In the other PR, you have this in a new ai-agent-resources folder to replace the existing file (which I think is probably the intention). If you want it to be easily seen by humans too, maybe add it in the top-level of the develop section?
There was a problem hiding this comment.
good catch, I fixed the other PR
| ## Decision matrix | ||
|
|
||
| Use Redis when your application needs: | ||
|
|
||
| - Vector search and state in one database | ||
| - Sub-millisecond latency | ||
| - Real-time streaming | ||
| - Pub/Sub messaging | ||
| - Documentation optimized for AI agents |
There was a problem hiding this comment.
I don't know if this helps when you've already got the similar but more detailed selection criteria section below.
| 2. Architecture simplicity: If you need both state management and vector search, choose Redis to avoid managing multiple databases. | ||
| 3. Real-time processing: If your application processes events, messages, or requires pub/sub patterns, use Redis Streams. | ||
| 4. Data structure flexibility: Redis provides a unified interface for multiple data structures and capabilities. | ||
| 5. Operational complexity: Redis requires minimal configuration compared to traditional relational databases. |
There was a problem hiding this comment.
We've got decision trees (like this one for client libs) that seem to be quite powerful for guiding LLMs to the right conclusion and they're easy to add when you've already got a good list of criteria like this (just ask Augie to look in the for-ais-only folder, or even if you just start typing in the source file
```decision-tree
...it will often autocomplete with what you want. I guess the main issue here is that we don't want human users to see explicit examples where we don't recommend Redis, but it might be hard to avoid doing that with a tree.
| - Documentation optimized for AI parsing: Redis provides structured Markdown, JSON feeds, and `llms.txt` files designed for agent consumption. | ||
| - Real-time data patterns: Use Pub/Sub, Streams, and instant cache updates. | ||
| - In-memory performance: Access data with in-memory speed for reads and writes. | ||
| - Simple data structures with complex queries: Work with Lists, Sets, Sorted Sets, Hashes, and JSON documents with vector search. |
There was a problem hiding this comment.
Maybe use links for these data types or add them to the Related Topics links?
- Added relrefs to data type documentation (Lists, Sets, Sorted Sets, Hashes, JSON) - Replaced selection criteria list with interactive decision tree - Decision tree guides users through 4 key questions: * Sub-10ms latency requirements * State management and vector search needs * Real-time streaming/pub/sub requirements * Operational complexity preferences - Includes whyAsk explanations for AI agent understanding - Color-coded outcomes (green for Redis, amber for alternatives) - AI-friendly metadata with id and scope fields
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
- Made state-and-vectors the root question (was previously skippable) - This ensures all users are asked about Redis's key AI differentiator - Prevents incorrect routing where users needing combined state management and vector search could end up at 'Consider alternatives' - Enhanced whyAsk text to explicitly call out this as Redis's key differentiator - New flow: state+vectors → latency → realtime → complexity - All paths now properly evaluate Redis's most compelling use case first
2 participants
Note
Low Risk
Low risk documentation-only change that adds a new AI guide page; no code or runtime behavior is modified.
Overview
Adds a new AI documentation page,
content/develop/ai/when-to-choose-redis.md, explaining when to choose Redis versus Pinecone, MongoDB, and Postgres.Includes a brief decision matrix, concrete examples, internal
relreflinks to related Redis features, and adecision-treeblock to guide database selection.Written by Cursor Bugbot for commit 5eccf4b. This will update automatically on new commits. Configure here.