explainx.ainewsletter3.4k
Productivity

sanity-best-practices▌

sanity-io/agent-toolkit · updated Apr 8, 2026

MDX-style export adds YAML metadata + attribution linking explainx.ai and this canonical listing URL.

$npx skills add https://github.com/sanity-io/agent-toolkit --skill sanity-best-practices
0 commentsdiscussion
summary

Comprehensive best practices and integration guides for Sanity CMS development across frameworks and topics.

  • ›Covers 10+ framework integrations including Next.js, Nuxt, Astro, Remix, SvelteKit, and Angular with framework-specific patterns and setup guidance
  • ›Includes topic guides for schema design, GROQ query optimization, Visual Editing, Portable Text, images, TypeGen, localization, and content migrations
  • ›Provides quick-reference structure for loading only relevant guides based on tas
skill.md

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 projects
  • nextjs - Next.js App Router, Live Content API, embedded Studio
  • nuxt - Nuxt integration with @nuxtjs/sanity
  • angular - Angular integration with @sanity/client, signals, resource API
  • astro - Astro integration with @sanity/astro
  • remix - React Router / Remix integration
  • svelte - SvelteKit integration with @sanity/svelte-loader
  • hydrogen - Shopify Hydrogen with Sanity
  • project-structure - Monorepo and embedded Studio patterns
  • app-sdk - Custom applications with Sanity App SDK
  • blueprints - Infrastructure as Code with Sanity Blueprints

Topic Guides

  • groq - GROQ query patterns, type safety, performance optimization
  • schema - Schema design, field definitions, validation, deprecation patterns
  • visual-editing - Presentation Tool, Stega, overlays, live preview
  • page-builder - Page Builder arrays, block components, live editing
  • portable-text - Rich text rendering and custom components
  • image - Image schema, URL builder, hotspots, LQIP, Next.js Image
  • studio-structure - Desk structure, singletons, navigation
  • typegen - TypeGen configuration, workflow, type utilities
  • seo - Metadata, sitemaps, Open Graph, JSON-LD
  • localization - i18n patterns, document vs field-level, locale management
  • migration - 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
how to use sanity-best-practices

How to use sanity-best-practices on Cursor

AI-first code editor with Composer

1

Prerequisites

Before installing skills in Cursor, ensure your development environment meets these requirements:

  • ›Cursor installed and configured on your development machine
  • ›Node.js version 16.0+ with npm package manager (verify with node --version)
  • ›Active project directory or workspace where you want to add sanity-best-practices
2

Execute installation command

Execute the skills CLI command in your project's root directory to begin installation:

$npx skills add https://github.com/sanity-io/agent-toolkit --skill sanity-best-practices

The skills CLI fetches sanity-best-practices from GitHub repository sanity-io/agent-toolkit and configures it for Cursor.

3

Select Cursor when prompted

The CLI will show a list of available agents. Use arrow keys to navigate and space to select Cursor:

◆ Which agents do you want to install to?
│
│ ── Universal (.agents/skills) ── always included ────
│ • Amp
│ • Antigravity
│ • Cline
│ • Codex
│ ●Cursor(selected)
│ • Cursor
│ • Windsurf
4

Verify installation

Confirm successful installation by checking the skill directory location:

.cursor/skills/sanity-best-practices

Reload or restart Cursor to activate sanity-best-practices. Access the skill through slash commands (e.g., /sanity-best-practices) or your agent's skill management interface.

⚠

Security & Verification Notice

We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.

Skills execute code in your development environment. Always verify the publisher's identity, review recent commits, and test in isolated environments before production deployment.

Additional Resources

›View source code on GitHub›Skills CLI documentation›Learn more about Cursor›What are agent skills?

List & Monetize Your Skill

Submit your Claude Code skill and start earning

GET_STARTED →

Use Cases▌

User Story & Requirements Generation

Create detailed user stories, acceptance criteria, and feature specs

Example

Generate user stories for 'password reset feature' with acceptance criteria, edge cases, and test scenarios

✓

Reduce spec writing time by 50%, ensure comprehensive coverage

Competitive Analysis

Research competitors, compare features, identify gaps

Example

Analyze 5 competitor products, create feature comparison matrix, suggest differentiation opportunities

✓

Complete competitive research in 2 hours instead of 2 days

Roadmap Prioritization

Evaluate features using frameworks (RICE, ICE, Kano) and create prioritized backlogs

Example

Score 20 feature ideas using RICE framework, generate prioritized roadmap with rationale

✓

Make data-driven prioritization decisions faster

Stakeholder Communication

Draft PRDs, status updates, and stakeholder presentations

Example

Create executive summary of Q3 roadmap, monthly progress report, feature launch announcement

✓

Save 3-5 hours/week on communication overhead

Implementation Guide▌

Prerequisites

  • ›Claude Desktop or compatible AI client
  • ›Access to product documentation and roadmap tools (Jira, Notion, etc.)
  • ›Understanding of product management frameworks (RICE, Jobs-to-be-Done, etc.)
  • ›Stakeholder contact information and communication channels

Time Estimate

30-60 minutes to see productivity improvements

Installation Steps

  1. 1.Install product management skill
  2. 2.Start with user story generation for known feature
  3. 3.Progress to competitive analysis: research 2-3 competitors
  4. 4.Use for roadmap prioritization: apply RICE/ICE scoring
  5. 5.Draft stakeholder communications and refine based on feedback
  6. 6.Build template library for recurring PM tasks
  7. 7.Share effective prompts with product team

Common Pitfalls

  • ⚠Not validating competitive research—verify facts before sharing
  • ⚠Accepting user stories without involving engineering team
  • ⚠Over-relying on frameworks without qualitative judgment
  • ⚠Not customizing outputs to company culture and communication style
  • ⚠Skipping stakeholder validation of generated requirements

Best Practices▌

✓ Do

  • +Validate research and competitive analysis with real data
  • +Collaborate with engineering when generating technical requirements
  • +Customize frameworks and templates to your company context
  • +Use skill for first drafts, refine with stakeholder input
  • +Document successful prompt patterns for PM tasks
  • +Combine AI efficiency with human judgment and intuition

✗ Don't

  • −Don't publish competitive analysis without fact-checking
  • −Don't finalize user stories without engineering review
  • −Don't make prioritization decisions solely on AI scoring
  • −Don't skip customer validation of generated requirements
  • −Don't ignore company-specific context and culture

💡 Pro Tips

  • ★Provide context: company goals, constraints, customer feedback
  • ★Ask for alternatives: 'Show 3 ways to prioritize this roadmap'
  • ★Request stakeholder-specific formatting: 'Executive summary vs. engineering spec'
  • ★Use skill for 70% generation + 30% customization to company needs

When to Use This▌

✓ Use When

Use for user story writing, competitive research, roadmap prioritization, stakeholder communication, and PRD drafting. Best for reducing repetitive documentation and research work.

✗ Avoid When

Avoid for strategic product vision (requires deep customer empathy), pricing decisions (needs market and financial expertise), or when face-to-face customer discovery is more valuable than speed.

Learning Path▌

  1. 1Basic: user stories, feature specs, status updates
  2. 2Intermediate: competitive analysis, prioritization frameworks, PRDs
  3. 3Advanced: product strategy, go-to-market planning, OKR setting
  4. 4Expert: product vision, market positioning, business model innovation

Discussion

Product Hunt–style comments (not star reviews)
  • No comments yet — start the thread.
general reviews

Ratings

4.6★★★★★57 reviews
  • ★★★★★Ren Sanchez· Dec 28, 2024

    Useful defaults in sanity-best-practices — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • ★★★★★Nikhil Nasser· Dec 24, 2024

    sanity-best-practices has been reliable in day-to-day use. Documentation quality is above average for community skills.

  • ★★★★★Min Brown· Dec 24, 2024

    sanity-best-practices is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.

  • ★★★★★Diego Patel· Dec 20, 2024

    Solid pick for teams standardizing on skills: sanity-best-practices is focused, and the summary matches what you get after install.

  • ★★★★★Diego Menon· Dec 4, 2024

    Useful defaults in sanity-best-practices — fewer surprises than typical one-off scripts, and it plays nicely with `npx skills` flows.

  • ★★★★★Soo Dixit· Nov 23, 2024

    I recommend sanity-best-practices for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • ★★★★★Mei Agarwal· Nov 19, 2024

    I recommend sanity-best-practices for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.

  • ★★★★★Charlotte Sethi· Nov 15, 2024

    sanity-best-practices reduced setup friction for our internal harness; good balance of opinion and flexibility.

  • ★★★★★Alexander Desai· Nov 15, 2024

    Keeps context tight: sanity-best-practices is the kind of skill you can hand to a new teammate without a long onboarding doc.

  • ★★★★★Alexander Chawla· Nov 3, 2024

    We added sanity-best-practices from the explainx registry; install was straightforward and the SKILL.md answered most questions upfront.

showing 1-10 of 57

1 / 6