Pennington.DocSite.ContentArea

namespace Pennington.DocSite;

/// Defines a content area within a documentation site. Each area maps to a top-level directory and URL prefix, and gets its own TOC section.
public record ContentArea
{
    /// Defines a content area within a documentation site. Each area maps to a top-level directory and URL prefix, and gets its own TOC section.
    
public ContentArea(string Title, string Slug, string Icon = null, int? SearchBoost = default)
;

    /// Optional SVG or markup for an icon beside the title.
    
public string Icon { get; set; }


    /// Optional search ranking boost for this area, relative to SearchIndexOptions.DefaultPriority (positive promotes, negative demotes). When null, the area is auto-boosted by its position in the list — earlier areas weigh more — so task-oriented docs lead over reference when matches are comparable. Set it to override that default for a specific area.
    
public int? SearchBoost { get; set; }


    /// URL path prefix / top-level directory name (e.g., "getting-started").
    
public string Slug { get; set; }


    /// Display name shown in the area selector (e.g., "Getting Started").
    
public string Title { get; set; }

}