DocShell.Presentation.Site (DocShell v0.5.0)

Copy Markdown View Source

Contains one validated doc-shell-site/v1 generation.

A site binds an exact collection cohort to pages, routes, navigation, search, redirects, locale policy, and host metadata. cohort_digest identifies the source and profile content deterministically; generation_id distinguishes publication attempts. Renderers consume this value without reading collection directories or repeating visibility and route decisions.

Summary

Types

t()

A portable site generation with one coherent source cohort.

Functions

Returns the portable site schema identifier.

Types

t()

@type t() :: %DocShell.Presentation.Site{
  base_path: String.t(),
  cohort_digest: String.t(),
  default_locale: String.t(),
  generation_id: String.t(),
  locales: [String.t()],
  metadata: map(),
  navigation: [DocShell.Presentation.NavigationItem.t()],
  pages: %{required(String.t()) => DocShell.Presentation.Page.t()},
  profile: String.t(),
  redirects: %{required(String.t()) => String.t()},
  routes: %{required(String.t()) => String.t()},
  schema_version: String.t(),
  search: [DocShell.Presentation.SiteSearchEntry.t()],
  title: String.t()
}

A portable site generation with one coherent source cohort.

Functions

schema_version()

@spec schema_version() :: String.t()

Returns the portable site schema identifier.