DocShell.Presentation.NavigationItem (DocShell v0.1.0)

Copy Markdown View Source

One node in the documentation navigation tree.

kind and meta describe where an entry came from — "module", "guide", and whatever the producer chose to carry alongside. A producer with no such notion leaves them at their defaults rather than omitting the keys, so every artifact has the same shape and a renderer never has to ask which producer wrote it.

Summary

Types

t()

Types

t()

@type t() :: %DocShell.Presentation.NavigationItem{
  children: [t()],
  id: String.t(),
  kind: String.t() | nil,
  meta: %{optional(String.t()) => term()},
  path: String.t(),
  title: String.t()
}