From 907fc51236f208008f8cc54e4b3a279c86894a51 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Sun, 4 Oct 2026 14:26:46 +0000 Subject: [PATCH] Correct composed configuration example description --- docs/config.md | 9 ++++++--- docs/roadmap/remediation.md | 9 ++++++++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/config.md b/docs/config.md index 06bb808..ae37e2b 100644 --- a/docs/config.md +++ b/docs/config.md @@ -92,9 +92,12 @@ including sequences and explicit nulls, before applying explicit CLI flags. An active overlay needs a selected base file. No-source defaults-only loads cannot use imports or an active overlay. -The [composed example](../examples/config.composed.yml) imports two fragments -and has a selectable [local overlay](../examples/overlays/local.yml). From the -repository root: +The [composed example](../examples/config.composed.yml) imports the application +[source-selection fragment](../examples/config-fragments/sources.yml) and has +a selectable [local overlay](../examples/overlays/local.yml). That fragment +selects the [framework backend file](../examples/framework/backends.yml) through +`promptkit_sources`; backend definitions are not imported into the application +document. From the repository root: ```bash go run ./cmd/scriptorium render \ diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index d68e64b..fbe5e44 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -59,7 +59,7 @@ documentation link/diff checks passed; no production code changed. ### R4: Update The Composed-Example Description -Priority: P3 (low). Status: Open. +Priority: P3 (low). Status: Complete. Location: `docs/config.md:95–96`, after the example migration in `2027b80`. @@ -78,6 +78,13 @@ the old prose. The old backend fragment had no application defaults to preserve. Acceptance: the description matches the maintained files and the existing composed-overlay render command still succeeds offline. +Resolution: the configuration reference now links to the one imported +application source-selection fragment and the separately selected framework +backend file, retaining the local-overlay example. The existing composed-overlay +render command passed offline with credential environment variables unset; +the linked files and diff whitespace were checked. No configuration files or +loading behavior changed. + ### R5: Include Framework Configuration Inspection In Built-In Usage Priority: P3 (low). Status: Open.