Refine render documentation for required flags and workflow examples

This commit is contained in:
2026-05-24 23:01:41 +00:00
parent 6dfc1ea527
commit da3720693d
3 changed files with 5 additions and 3 deletions

View File

@@ -156,6 +156,7 @@ Flags:
- Input must be a valid existing seriatim output artifact (`seriatim-minimal`, `seriatim-intermediate`, or `seriatim-full`). - Input must be a valid existing seriatim output artifact (`seriatim-minimal`, `seriatim-intermediate`, or `seriatim-full`).
- Raw WhisperX-style JSON is rejected. - Raw WhisperX-style JSON is rejected.
- `render` does not execute merge/trim/normalize transformations. - `render` does not execute merge/trim/normalize transformations.
- `render` has no `--report-file` output in the current implementation.
- Markdown output is deterministic for the same input artifact and render flags. - Markdown output is deterministic for the same input artifact and render flags.
- Category names are not printed directly; `background`, `backchannel`, and `filler` only influence italics. - Category names are not printed directly; `background`, `backchannel`, and `filler` only influence italics.

View File

@@ -25,7 +25,8 @@ For `trim`:
## Render format and defaults ## Render format and defaults
`render` requires `--format`. Current supported value is `markdown`. `render` requires `--input-file`, `--output-file`, and `--format`.
Current supported format value is `markdown`.
Render defaults: Render defaults:

View File

@@ -93,8 +93,8 @@ Example:
```sh ```sh
go run ./cmd/seriatim render \ go run ./cmd/seriatim render \
--input-file normalized.json \ --input-file examples/render/input-intermediate.json \
--output-file transcript.md \ --output-file /tmp/seriatim-example-render.md \
--format markdown --format markdown
``` ```