Clarify diagnostic plugin command context
This commit is contained in:
parent
6f29f59d54
commit
4495d03f15
|
|
@ -3,18 +3,17 @@
|
|||
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.
|
||||
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
|
||||
./build.sh render diagnostic /path/to/capture.json --output diagnostic.pdf --author 'Reviewer' --theme cic
|
||||
```
|
||||
|
||||
Themes are `default`, `cic`, and `eridani`. The integration command
|
||||
`build.sh render diagnostic CAPTURE.json --output OUTPUT.pdf` invokes this renderer.
|
||||
Themes are `default`, `cic`, and `eridani`.
|
||||
|
||||
`analyse.sh` remains available when normalized diagnostic JSON v1 and evidence
|
||||
pointers are needed. Its output is independent of the source-faithful PDF path.
|
||||
`./build.sh analyze` produces normalized diagnostic JSON v1 with evidence
|
||||
pointers when needed. Its output is independent of the source-faithful PDF.
|
||||
|
||||
The public entry point is `../../build.sh`. The plugin also supplies evidence
|
||||
validation and analysis commands through that CLI. See
|
||||
The plugin supplies evidence validation through the same CLI. See
|
||||
[the plugin guide](../../docs/plugins.md) for ownership rules and tests.
|
||||
|
|
|
|||
Loading…
Reference in New Issue