From da3720693dbf61ba4220bbf04c5c45ad7b54042a Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Sun, 24 May 2026 23:01:41 +0000 Subject: [PATCH] Refine render documentation for required flags and workflow examples --- docs/cli.md | 1 + docs/config.md | 3 ++- docs/operations.md | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 8d1164f..c4f5606 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -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. diff --git a/docs/config.md b/docs/config.md index 254ea06..5abeb9b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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: diff --git a/docs/operations.md b/docs/operations.md index 60c8a28..06442df 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -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 ```