CLOUD-4245 improve-redis-search-docs

[up-ilter]

No description provided.

[linear]

CLOUD-4245 Improve redis-search docs

[Copilot]

Pull request overview

Adds and expands Upstash Redis Search documentation to make common usage patterns and failure modes easier to understand, with new reference-style pages and clearer response/parameter explanations.

Changes:

• Added new Command Reference and Troubleshooting pages for Redis Search.
• Expanded existing docs with response-format sections (query + aggregations) and added schema FAST/field-type reference material.
• Updated navigation to include the new pages.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
redis/search/troubleshooting.mdx	New troubleshooting guide covering common index/query/aggregation/schema errors.
redis/search/command-reference.mdx	New command reference for SEARCH.* commands, parameters, and return formats.
redis/search/schema-definition.mdx	Adds field type reference table and FAST field explanation.
redis/search/querying.mdx	Documents query response format and adds LIMIT/OFFSET parameter table.
redis/search/query-operators/field-operators/overview.mdx	Adds quick-reference table for field operators.
redis/search/aggregations.mdx	Documents aggregation response format and adds FAST-field note.
redis/search/aggregation-operators/metric-aggregations/overview.mdx	Clarifies metric operator input format and common error messages.
redis/search/aggregation-operators/bucket-aggregations/overview.mdx	Clarifies bucket operator input format and nested $aggs behavior.
redis/search/index-management.mdx	Clarifies what SEARCH.WAITINDEXING waits for and when to use it.
redis/search/counting.mdx	Clarifies that SEARCH.COUNT returns a single integer.
docs.json	Adds the new Search docs pages to the sidebar/navigation.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[up-ilter]

Nitpick Review

Summary

Comprehensive documentation enhancement for Redis Search that adds two new guide pages (Command Reference and Troubleshooting) and enriches existing guides with request/response format examples, reference tables, and practical code samples across TypeScript, Python, and Redis CLI.

Key changes:

• Added new Command Reference page documenting all SEARCH.* commands (SEARCH.CREATE, SEARCH.QUERY, SEARCH.AGGREGATE, SEARCH.COUNT, alias commands, etc.) with syntax, parameters, and examples
• Added new Troubleshooting page covering common errors and fixes (index creation, query syntax, aggregation field requirements, schema issues, Upstash vs RediSearch differences)
• Enhanced aggregation documentation with Response Format section showing result structures for TypeScript, Python, and Redis CLI with practical examples
• Added Input Format sections to bucket and metric aggregation overviews with JSON examples for each operator type
• Created Field Type Reference table documenting all field types (TEXT, KEYWORD, F64, DATE, BOOL, FACET) with FAST support and supported operators
• Enhanced query documentation with Response Format examples and LIMIT/OFFSET parameter reference table
• Added Field Operators Quick Reference table and expanded SEARCH.WAITINDEXING documentation with guidance on optimal usage patterns

Verdict

Metric	Value
Risk Score	35/100
Recommendation	request changes
Findings	13 accepted

Found 13 issue(s) across all reviewers. 5 blocking issue(s) require attention before merge. Overall risk score: 35/100. Changes are requested before merging.

Blockers

• 🟠 HIGH Bearer Token detected in added code (redis/search/command-reference.mdx:39)
• 🟠 HIGH Bearer Token detected in added code (redis/search/command-reference.mdx:144)
• 🟠 HIGH Bearer Token detected in added code (redis/search/command-reference.mdx:171)
• 🟠 HIGH Bearer Token detected in added code (redis/search/command-reference.mdx:208)
• 🟠 HIGH Bearer Token detected in added code (redis/search/command-reference.mdx:261)

Suggested Commits

• fix: bearer token detected in added code
• fix: bearer token detected in added code
• fix: bearer token detected in added code
• fix: bearer token detected in added code
• fix: bearer token detected in added code

---

Generated by Nitpick