Sanity Best Practices

1---
2name: sanity-best-practices
3description: Comprehensive Sanity development best practices covering GROQ performance, schema design, Visual Editing, images, Portable Text, page builders, Studio configuration, TypeGen, localization, and migrations. Use this skill when building, reviewing, or optimizing Sanity applications.
4license: MIT
5metadata:
6  author: sanity
7  version: "1.0.0"
8---
9 
10# Sanity Best Practices
11 
12Comprehensive best practices guide for Sanity development, maintained by Sanity. Contains rules across 10 categories, prioritized by impact to guide schema design, query optimization, and frontend integration.
13 
14## When to Apply
15 
16Reference these guidelines when:
17- Writing GROQ queries or optimizing performance
18- Designing content schemas
19- Implementing Visual Editing and live preview
20- Working with images, Portable Text, or page builders
21- Configuring Sanity Studio structure
22- Setting up TypeGen for type safety
23- Implementing localization
24- Migrating content from other systems
25 
26## Rule Categories by Priority
27 
28| Priority | Category | Impact | Prefix |
29|----------|----------|--------|--------|
30| 1 | GROQ Performance | CRITICAL | `groq-` |
31| 2 | Schema Design | HIGH | `schema-` |
32| 3 | Visual Editing | HIGH | `visual-` |
33| 4 | Images | HIGH | `image-` |
34| 5 | Portable Text | HIGH | `pte-` |
35| 6 | Page Builder | MEDIUM | `pagebuilder-` |
36| 7 | Studio Configuration | MEDIUM | `studio-` |
37| 8 | TypeGen | MEDIUM | `typegen-` |
38| 9 | Localization | MEDIUM | `i18n-` |
39| 10 | Migration | LOW-MEDIUM | `migration-` |
40 
41## How to Use
42 
43Read individual rule files for detailed explanations and code examples:
44 
45```
46rules/groq-optimizable-filters.md
47rules/schema-data-over-presentation.md
48rules/_sections.md
49```
50 
51Each rule file contains:
52- Brief explanation of why it matters
53- Incorrect code example with explanation
54- Correct code example with explanation
55- Additional context and references
56- Framework-specific notes (when applicable)
57 
58## Framework Integration
59 
60Framework-specific guidance (Next.js, Astro, Remix, etc.) is available via the Sanity MCP server using `list_sanity_rules` and `get_sanity_rules` tool calls when available. If the MCP server is not configured, run `npx sanity@latest mcp configure` to set it up.
61