diff --git a/docs/consumers/upgrading-promptkit.md b/docs/consumers/upgrading-promptkit.md index a77191e..41e671d 100644 --- a/docs/consumers/upgrading-promptkit.md +++ b/docs/consumers/upgrading-promptkit.md @@ -72,10 +72,15 @@ profiles: Select prompts by exact ID; `--prompt-version` is rejected. If multiple former versions must remain independently selectable, give them distinct IDs and update callers. Qualified IDs such as `support/answer` are passed unchanged. -Keep relative message files beside their owning definitions. Convert framework -source controls from `configkit:` to `config:` and add `required: true` for -imports that must exist. An optional framework source header, if present, is -`version: 2`. Use sibling inheritance such as `extends: {id: base}`. +PromptKit resolves `content_file` relative to the source that supplied the +field, including imported or inherited definitions. The +[framework format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md#messages-and-templates) +describes which paths are allowed within the source root. + +Convert framework source controls from `configkit:` to `config:` and add +`required: true` for imports that must exist. An optional framework source +header, if present, is `version: 2`. Use sibling inheritance such as +`extends: {id: base}`. Composition now replaces a whole record when a later source selects the same ID; supply the complete intended replacement, or create a distinct inherited diff --git a/docs/roadmap/remediation.md b/docs/roadmap/remediation.md index 56f232b..825e07c 100644 --- a/docs/roadmap/remediation.md +++ b/docs/roadmap/remediation.md @@ -33,6 +33,10 @@ timeout or release gate. ## R2: Describe source-relative message paths without a colocation rule (Stage 7) +**Complete.** The migration guide describes source-relative resolution and +links to PromptKit's path rules. A render with a message in a subdirectory +confirmed that no colocation is required. + The [upgrade guide](../consumers/upgrading-promptkit.md) instructs users to keep message files beside their owning definitions. PromptKit resolves `content_file` against the field's declaring source within its rooted