reportist/plugins/diagnostics/README.md

20 lines
851 B
Markdown

# Diagnostic plugin
The diagnostic renderer consumes a raw WinDiagnostics JSON v1/v2 capture and
builds its PDF with `renderer/render.typ`, `renderer/normalize.typ`, and
`renderer/model.typ`. It imports graphical elements and palettes from the
local Reportist visual module; it does not convert the capture into a report
model. From the Reportist repository root:
```bash
./build.sh render diagnostic /path/to/capture.json --output diagnostic.pdf --author 'Reviewer' --theme cic
```
Named themes are listed in [the palette catalog](../../visual/README.md).
`./build.sh analyze` produces normalized diagnostic JSON v1 with evidence
pointers when needed. Its output is independent of the source-faithful PDF.
The plugin supplies evidence validation through the same CLI. See
[the plugin guide](../../docs/plugins.md) for ownership rules and tests.