Refine render documentation for required flags and workflow examples
This commit is contained in:
@@ -156,6 +156,7 @@ Flags:
|
||||
- Input must be a valid existing seriatim output artifact (`seriatim-minimal`, `seriatim-intermediate`, or `seriatim-full`).
|
||||
- Raw WhisperX-style JSON is rejected.
|
||||
- `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.
|
||||
- Category names are not printed directly; `background`, `backchannel`, and `filler` only influence italics.
|
||||
|
||||
|
||||
@@ -25,7 +25,8 @@ For `trim`:
|
||||
|
||||
## 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:
|
||||
|
||||
|
||||
@@ -93,8 +93,8 @@ Example:
|
||||
|
||||
```sh
|
||||
go run ./cmd/seriatim render \
|
||||
--input-file normalized.json \
|
||||
--output-file transcript.md \
|
||||
--input-file examples/render/input-intermediate.json \
|
||||
--output-file /tmp/seriatim-example-render.md \
|
||||
--format markdown
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user