SelectoMix.DomainDocs (selecto_mix v0.4.6)

Renders Markdown documentation from normalized Selecto domain artifacts.

The docs renderer consumes the same checked artifact shape used by selecto.domain.check, inspect, and diff, so it documents the portable normalized JSON artifact rather than requiring the original domain module.

Summary

Functions

render(summary, domain)

render_check(check)

render_file(path, opts \\ [])

Functions

render(summary, domain)

@spec render(map(), map()) :: String.t()

render_check(check)

@spec render_check(map()) :: String.t()

render_file(path, opts \\ [])

@spec render_file(
  Path.t(),
  keyword()
) :: {:ok, String.t()} | {:error, SelectoMix.DomainExport.artifact_error()}