From f3310d4d164280a7bc368391d848c3d5f015445d Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Mon, 25 May 2026 00:48:15 +0000 Subject: [PATCH] Finalize render documentation across operations, integrations, troubleshooting, and roadmap status --- docs/integrations/README.md | 2 +- docs/operations.md | 2 +- docs/roadmap/render.md | 2 +- docs/troubleshooting.md | 27 +++++++++++++++++++++++++++ 4 files changed, 30 insertions(+), 3 deletions(-) diff --git a/docs/integrations/README.md b/docs/integrations/README.md index a2192aa..533ac93 100644 --- a/docs/integrations/README.md +++ b/docs/integrations/README.md @@ -10,7 +10,7 @@ These docs cover what Narratio expects from external tools and what each adapter ## Integration Contracts - `audita.md`: transcript polishing adapter (`audita process`). -- `seriatim.md`: merge/normalize/trim adapter (`seriatim`). +- `seriatim.md`: merge/normalize/trim/render adapter (`seriatim`). - `scriptorium.md`: artifact run/render adapter (`scriptorium run|render`). ## Related Canonical Docs diff --git a/docs/operations.md b/docs/operations.md index 49a6296..e015f9c 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -245,7 +245,7 @@ Rules: ## Operational Caveats - Local and S3 audio modes are mutually exclusive. -- Publish requires prerequisite stages through analyze to be succeeded. +- Publish requires prerequisite stages through `render` and `analyze` to be succeeded. - Markdown publish defaults require render outputs (`transcripts/final.md` and `transcripts/final.trimmed.md`). - Restore requires configured object storage and committed remote current state. - Storage-backed commands load filesystem secrets before object-store initialization. diff --git a/docs/roadmap/render.md b/docs/roadmap/render.md index ce0ad00..c5efabf 100644 --- a/docs/roadmap/render.md +++ b/docs/roadmap/render.md @@ -1,6 +1,6 @@ # Roadmap: Render Stage -Status: Planned +Status: Completed This roadmap defines a post-1.0 feature addition: a new `render` stage that uses `seriatim render` to produce human-readable Markdown versions of the final transcript artifacts. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index f16bc78..d3362b4 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -217,6 +217,33 @@ Safe fix: - correct publish source/destination rules; - retry after storage failure is resolved. +## Render markdown source missing + +Symptom: + +- analyze or publish fails because `narratio.transcript.final_markdown` or `narratio.transcript.final_trimmed_markdown` is unavailable. + +Likely causes: + +- render stage was not executed after transcript changes; +- render stage failed before producing canonical markdown outputs. + +Diagnostics: + +```bash +narratio session status 2026-04-04 +narratio run-stage render 2026-04-04 --force +``` + +Safe fix: + +- rerun render and then retry downstream stage(s): + +```bash +narratio run-stage render 2026-04-04 --force +narratio run-stage analyze 2026-04-04 --force +``` + ## Secrets or storage credential failure Symptom: