mcpField
C
content-modeling-best-practices

content-modeling-best-practices

github.com/sanity-ioData & databases1944.9k installsUpdated 1d ago
Repository

About content-modeling-best-practices

A content-modeling guide for teams designing structured content in headless CMS projects, with principles and focused references for common modeling decisions. It includes Sanity-specific implementation notes.

Key features

  1. 01Guidance on structuring content
  2. 02Single-source-of-truth principles
  3. 03Planning for multiple channels
  4. 04Editor-centered model design
  5. 05Focused topic references

Use cases

  1. 01Designing a new content model
  2. 02Choosing structured or free-form content
  3. 03Deciding between references and embedded objects
  4. 04Refactoring existing content structures

Install

Copy the command and run it in a terminal.

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

After installing, type/content-modeling-best-practicesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
content-reuse.md
reference-vs-embedding.md
separation-of-concerns.md
taxonomy-classification.md

Details

From the project README

Content Modeling Best Practices

Principles for designing structured content that's flexible, reusable, and maintainable. These concepts apply to any headless CMS but include Sanity-specific implementation notes.

When to Apply

Reference these guidelines when:

  • Starting a new project and designing the content model
  • Evaluating whether content should be structured or free-form
  • Deciding between references and embedded content
  • Planning for multi-channel content delivery
  • Refactoring existing content structures

Core Principles

  1. Content is data, not pages — Structure content for meaning, not presentation
  2. Single source of truth — Avoid content duplication
  3. Future-proof — Design for channels that don't exist yet
  4. Editor-centric — Optimize for the people creating content

References

Start with the reference that matches the modeling decision in front of you, instead of loading every topic at once. See references/ for detailed guidance on specific topics:

  • references/separation-of-concerns.md — Separating content from presentation
  • references/reference-vs-embedding.md — When to use references vs embedded objects
  • references/content-reuse.md — Content reuse patterns and the reuse spectrum
  • references/taxonomy-classification.md — Flat, hierarchical, and faceted classification

Comments

Markdown supported