Sanity Best Practices
Comprehensive best practices and integration guides for Sanity development, maintained by Sanity. Use the quick reference below to load only the one or two topic files that match the task.
When to Apply
Reference these guidelines when:
- Setting up a new Sanity project or onboarding
- Integrating Sanity with a frontend framework (Next.js, Nuxt, Astro, Remix, SvelteKit, Hydrogen)
- Writing GROQ queries or optimizing performance
- Designing content schemas
- Implementing Visual Editing and live preview
- Working with images, Portable Text, or page builders
- Configuring Sanity Studio structure
- Setting up TypeGen for type safety
- Implementing localization
- Migrating content from other systems
- Building custom apps with the Sanity App SDK
- Managing infrastructure with Blueprints
Quick Reference
Integration Guides
get-started - Interactive onboarding for new Sanity projectsnextjs - Next.js App Router, Live Content API, embedded Studionuxt - Nuxt integration with @nuxtjs/sanityangular - Angular integration with @sanity/client, signals, resource APIastro - Astro integration with @sanity/astroremix - React Router / Remix integrationsvelte - SvelteKit integration with @sanity/svelte-loaderhydrogen - Shopify Hydrogen with Sanityproject-structure - Monorepo and embedded Studio patternsapp-sdk - Custom applications with Sanity App SDKblueprints - Infrastructure as Code with Sanity Blueprints
Topic Guides
groq - GROQ query patterns, type safety, performance optimizationschema - Schema design, field definitions, validation, deprecation patternsvisual-editing - Presentation Tool, Stega, overlays, live previewpage-builder - Page Builder arrays, block components, live editingportable-text - Rich text rendering and custom componentsimage - Image schema, URL builder, hotspots, LQIP, Next.js Imagestudio-structure - Desk structure, singletons, navigationtypegen - TypeGen configuration, workflow, type utilitiesseo - Metadata, sitemaps, Open Graph, JSON-LDlocalization - i18n patterns, document vs field-level, locale managementmigration - Content import overview (see also migration-html-import)migration-html-import - HTML to Portable Text with @portabletext/block-tools
How to Use
Start with the single framework or topic guide that best matches the request, then read additional references only when the task crosses concerns. Use these reference files for detailed explanations and code examples:
references/groq.md
references/schema.md
references/nextjs.md
Each reference file contains:
- Comprehensive topic or integration coverage
- Incorrect and correct code examples
- Decision matrices and workflow guidance
- Framework-specific patterns where applicable
1---2name: sanity-best-practices-23description: Sanity development best practices for schema design, GROQ queries, TypeGen, Visual Editing, images, Portable Text, Studio structure, localization, migrations, and framework integrations such as Next.js, Nuxt, Astro, Remix, SvelteKit, Angular, Hydrogen, and the App SDK. Use this skill whenever working with Sanity schemas, defineType or defineField, GROQ or defineQuery, content modeling, Presentation or preview setups, Sanity-powered frontend integrations, or when reviewing and fixing a Sanity codebase.4---5
6# Sanity Best Practices
7
8Comprehensive best practices and integration guides for Sanity development, maintained by Sanity. Use the quick reference below to load only the one or two topic files that match the task.
9
10## When to Apply
11
12Reference these guidelines when:
13- Setting up a new Sanity project or onboarding
14- Integrating Sanity with a frontend framework (Next.js, Nuxt, Astro, Remix, SvelteKit, Hydrogen)
15- Writing GROQ queries or optimizing performance
16- Designing content schemas
17- Implementing Visual Editing and live preview
18- Working with images, Portable Text, or page builders
19- Configuring Sanity Studio structure
20- Setting up TypeGen for type safety
21- Implementing localization
22- Migrating content from other systems
23- Building custom apps with the Sanity App SDK
24- Managing infrastructure with Blueprints
25
26## Quick Reference
27
28### Integration Guides
29
30- `get-started` - Interactive onboarding for new Sanity projects
31- `nextjs` - Next.js App Router, Live Content API, embedded Studio
32- `nuxt` - Nuxt integration with @nuxtjs/sanity
33- `angular` - Angular integration with @sanity/client, signals, resource API
34- `astro` - Astro integration with @sanity/astro
35- `remix` - React Router / Remix integration
36- `svelte` - SvelteKit integration with @sanity/svelte-loader
37- `hydrogen` - Shopify Hydrogen with Sanity
38- `project-structure` - Monorepo and embedded Studio patterns
39- `app-sdk` - Custom applications with Sanity App SDK
40- `blueprints` - Infrastructure as Code with Sanity Blueprints
41
42### Topic Guides
43
44- `groq` - GROQ query patterns, type safety, performance optimization
45- `schema` - Schema design, field definitions, validation, deprecation patterns
46- `visual-editing` - Presentation Tool, Stega, overlays, live preview
47- `page-builder` - Page Builder arrays, block components, live editing
48- `portable-text` - Rich text rendering and custom components
49- `image` - Image schema, URL builder, hotspots, LQIP, Next.js Image
50- `studio-structure` - Desk structure, singletons, navigation
51- `typegen` - TypeGen configuration, workflow, type utilities
52- `seo` - Metadata, sitemaps, Open Graph, JSON-LD
53- `localization` - i18n patterns, document vs field-level, locale management
54- `migration` - Content import overview (see also `migration-html-import`)
55- `migration-html-import` - HTML to Portable Text with @portabletext/block-tools
56
57## How to Use
58
59Start with the single framework or topic guide that best matches the request, then read additional references only when the task crosses concerns. Use these reference files for detailed explanations and code examples:
60
61```
62references/groq.md
63references/schema.md
64references/nextjs.md
65```
66
67Each reference file contains:
68- Comprehensive topic or integration coverage
69- Incorrect and correct code examples
70- Decision matrices and workflow guidance
71- Framework-specific patterns where applicable
72
majiayu000