diff --git a/docs/development.md b/docs/development.md index 0971559..249c002 100644 --- a/docs/development.md +++ b/docs/development.md @@ -34,6 +34,7 @@ Start with: | Root public API | The [architecture policy](policy/architecture.md), [consumer guide](consumers/pkg-promptkit.md), [testing policy](policy/testing.md), and existing GoDoc. | | Prompt, profile, or schema formats | The [framework format reference](formats.md), owning parser or validator package, and [documentation policy](policy/documentation.md). | | Source loading or validation | The [framework format reference](formats.md), [internal source document](internal/sources.md), and owning package tests. | +| Maintained external catalogs or built-ins | The [internal source document](internal/sources.md), [framework format reference](formats.md), [testing policy](policy/testing.md), both catalog module repositories, and each catalog's release procedure. | | Model-client behavior | The [OpenAI-compatible integration contract](integrations/openai-compatible-chat.md), [internal model-client document](internal/llm.md), and owning package tests. | | Internal package implementation | The [architecture policy](policy/architecture.md), [internal component overview](internal/overview.md), and focused internal document listed for that package. | | Tests or test fixtures | The [testing policy](policy/testing.md), owning package, and focused internal document listed by the component overview. | diff --git a/docs/release.md b/docs/release.md index ec6823e..5e6bb84 100644 --- a/docs/release.md +++ b/docs/release.md @@ -146,6 +146,13 @@ grep -F 'Consumer action:' "$RELEASE_NOTES_FILE" Inspect the complete message and confirm that it accurately records the compatibility impact, public API changes, and required consumer action. +When a release introduces or updates the maintained external catalogs, state +that it selects two independently versioned data dependencies, preserves the +public API and configuration, requires no consumer migration, and guarantees +only the catalog versions selected and tested by that Promptkit release. Link +to the current architecture and format documentation rather than duplicating +catalog contracts in the release note. + ## Create And Inspect The Tag Run the candidate guard again immediately before tag creation. This ensures diff --git a/docs/roadmap/implementation.md b/docs/roadmap/implementation.md index 9cd703e..ab3b80e 100644 --- a/docs/roadmap/implementation.md +++ b/docs/roadmap/implementation.md @@ -594,7 +594,7 @@ from Promptkit in the same committed cutover. ## Stage 7: Update Current-State And Release Documentation -**Status:** Pending +**Status:** Complete ### Repository