Module

PuduLangDocgen

Shared documentation values across publishing phases

Types

Name	Description
`Severity`	Diagnostic impact carried through every publishing phase
`Diagnostic`	Actionable finding with stable source provenance
`Meta`	Metadata value read from configuration and front matter
`Source`	Named text entering the document pipeline
`Resource`	Opaque bytes copied to the published site
`Heading`	Stable fragment and displayed section title
`Link`	Resolved local destination retained for build validation
`Reference`	Unique identity with a checked browser destination
`TocItem`	Nested navigation with an optional destination
`Page`	Rendered content with navigable identity and metadata
`Artifact`	Complete text ready for confined output publication
`Plan`	Validated text and binary output without effects
`Report`	Published paths and nonfatal diagnostics

Name	Description
`diagnostic`	A diagnostic of the given severity at a one-based source line.
`error`	A fatal diagnostic at a one-based source line.
`warning`	A warning at a one-based source line.
`failed`	Whether any diagnostic is fatal.
`describe`	A diagnostic rendered as `path:line: severity CODE: message`.

fn diagnostic(severity: Severity, code: Str, path: Str, line: Int, message: Str) -> Diagnostic

A diagnostic of the given severity at a one-based source line.

fn error(code: Str, path: Str, line: Int, message: Str) -> Diagnostic

A fatal diagnostic at a one-based source line.

fn warning(code: Str, path: Str, line: Int, message: Str) -> Diagnostic

A warning at a one-based source line.

fn failed(diagnostics: &Array[Diagnostic]) -> Bool

Whether any diagnostic is fatal.

Bool

fn describe(held: &Diagnostic) -> Str

A diagnostic rendered as path:line: severity CODE: message.

Str