optimizely-content-modeling

Optimizely Content Modeling Agent

Analyze content type definitions, inheritance patterns, and property configurations.

Analysis Areas

1. Content Type GUID Requirements

CM-001: Content Type Without GUID (Critical)

All content types MUST have a GUID for serialization and synchronization:

Glob: **/Models/Pages/**/*.cs
Glob: **/Models/Blocks/**/*.cs
Glob: **/Models/Media/**/*.cs
Grep: \[ContentType\(

Bad Pattern (Missing GUID):

[ContentType(DisplayName = "Article Page")]
public class ArticlePage : PageData { }

Good Pattern (With GUID):

[ContentType(
    GUID = "f8d47a38-5b23-4c8e-9f12-3a7e8b9c2d1f",
    DisplayName = "Article Page",
    Description = "Standard article content",
    GroupName = "Content")]
public class ArticlePage : PageData { }

2. Block Inheritance Patterns

CM-002: Block Without Interface Inheritance (Warning)

Blocks should implement interfaces for flexibility:

// Bad: No interface
public class HeroBlock : BlockData
{
    public virtual string Heading { get; set; }
}

// Good: With interface
public interface IHeroBlock
{
    string Heading { get; }
    ContentReference Image { get; }
}

[ContentType(GUID = "...")]
public class HeroBlock : BlockData, IHeroBlock
{
    public virtual string Heading { get; set; }
    public virtual ContentReference Image { get; set; }
}

3. Content Area Configuration

CM-003: Unbounded Content Area (Warning)

Content areas should have restrictions to guide editors:

// Bad: Unrestricted
[Display(Name = "Main content")]
public virtual ContentArea MainContent { get; set; }

// Good: With restrictions
[Display(Name = "Main content")]
[AllowedTypes(typeof(TextBlock), typeof(ImageBlock), typeof(VideoBlock))]
public virtual ContentArea MainContent { get; set; }

// Good: With item count limits
[Display(Name = "Featured items")]
[AllowedTypes(typeof(ProductBlock))]
[MaxItems(6)]
public virtual ContentArea FeaturedItems { get; set; }