diff --git a/docs/integrations/openai-compatible-llm.md b/docs/integrations/openai-compatible-llm.md index 6931398..de6ca4d 100644 --- a/docs/integrations/openai-compatible-llm.md +++ b/docs/integrations/openai-compatible-llm.md @@ -19,7 +19,7 @@ failures; explicit zero makes one attempt. `llm.repair_attempts` counts additional generations for schema-invalid model output. The operation timeout covers preparation, capacity waiting, retries, generation, and repair. Caller cancellation or an earlier deadline also applies. See [configuration](../config.md#settings) -for defaults and [PromptKit's consumer contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md) +for defaults and [PromptKit's consumer contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.1/docs/consumers/pkg-promptkit.md) for the pinned protocol and retry details. A model operation that exhausts structural repair, a live-parent local operation diff --git a/docs/roadmap/library-adoption.md b/docs/roadmap/library-adoption.md index 9c41eb6..bc2b260 100644 --- a/docs/roadmap/library-adoption.md +++ b/docs/roadmap/library-adoption.md @@ -1,9 +1,9 @@ # Coordinated ConfigKit and PromptKit Adoption -**Last updated:** 2026-09-24 +**Last updated:** 2026-09-26 -**Status:** Production implementation complete. ConfigKit v0.4.0 and PromptKit -v0.11.0 are adopted; [historical implementation evidence](https://gitea.maximumdirect.net/eric/audita/src/commit/cb405f6/docs/roadmap/implementation.md) records the +**Status:** Production implementation complete. ConfigKit v0.4.1 and PromptKit +v0.11.1 are adopted; [historical implementation evidence](https://gitea.maximumdirect.net/eric/audita/src/commit/cb405f6/docs/roadmap/implementation.md) records the completed checks. The current `implementation.md` covers span deletion instead. Release compliance and publication remain separate work. @@ -23,7 +23,7 @@ Audita's transcript-correction capabilities and domain protections. The [configuration roadmap](configkit.md) owns configuration and inspection policy. The [boundary findings](library-boundary-findings.md) own the selected defaults, full migration inventory, failure mapping, and prototype evidence. The selected -production versions are ConfigKit v0.4.0 and PromptKit v0.11.0, with Go 1.25.5 as +production versions are ConfigKit v0.4.1 and PromptKit v0.11.1, with Go 1.25.5 as the minimum. Use published modules, never sibling checkouts or local replacements. The existing YAML dependency remains while glossary parsing needs it. diff --git a/docs/roadmap/policy.md b/docs/roadmap/policy.md index 58e1ab5..17ba663 100644 --- a/docs/roadmap/policy.md +++ b/docs/roadmap/policy.md @@ -7,10 +7,9 @@ roadmap defines the target and scope, not a staged implementation plan. ## Purpose -Align Audita's licensing documentation with the updated upstream policy set in -`../policy`, using its Open Source Licensing and Attribution Policy (base version -1.2) and the related documentation and release guidance. Adopt the licensing -changes deliberately while retaining Audita's existing policy adaptations. +Establish self-contained licensing and attribution documentation for Audita, +using the House Format defined below. Keep licensing, documentation ownership, +and release guidance consistent while retaining Audita's existing policies. Audita's selected grant is already GPL-3.0-or-later. This work documents that choice and the applicable upstream attribution; it does not reconsider the @@ -23,7 +22,7 @@ As of commit `982b595`: - [COPYRIGHT](../../COPYRIGHT) contains the project identity, copyright, GPL-3.0-or-later SPDX expression and grant, warranty disclaimer, and third-party statement. [LICENSE](../../LICENSE) contains the full GPLv3 text. These already - follow the substantive upstream convention and need no substantive revision. + follow the selected project licensing convention and need no substantive revision. - There is no `docs/policy/oss.md`, canonical `docs/oss/attribution.md`, or local dependency license-text collection. - The [documentation policy](../policy/documentation.md) lacks ownership and @@ -46,22 +45,42 @@ and arm64 are the supported production targets; macOS arm64 remains best-effort for local development. Successful release completion remains the successful push of the release source and tag, without waiting for CI asset publication. +## Reviewed Dependency Updates + +ConfigKit v0.4.1 and PromptKit v0.11.1 are now selected. Both make their +LGPL-3.0-or-later grant explicit in `COPYRIGHT` and provide the LGPLv3 and +incorporated GPLv3 texts together in `LICENSE`. Neither changes library code. +PromptKit also selects MIT-licensed OpenRouter and Rakestrawhome catalogs at +v2.20260926.0; those catalog updates leave Go code and profile data unchanged. + +Use the selected public source revisions as the starting points for their +attribution entries: + +- ConfigKit v0.4.1: `0adb94f59e44827908eff401d4381a398fe17107`. +- PromptKit v0.11.1: `15e40679546f2e21b6f51cc84b6f0a087a8486db`. +- OpenRouter catalog v2.20260926.0: `4f731d217e0bc39151c010f50fb5912706e7b6b3`. +- Rakestrawhome catalog v2.20260926.0: `48918a3ad39fd99843cda94a86133b1b3881d596`. + +Inspect the selected components directly. Dependency attribution documents can +help locate relevant notices, but should not be copied wholesale: Audita's +inventory reflects material actually incorporated into or distributed with Audita. + ## Targeted End State ### Canonical Policy and Ownership -Adopt `docs/policy/oss.md` from upstream base version 1.2, tailored to Audita's -selected grant and distribution. Remove template adoption instructions and -replace or remove template-only example and reference links. Retain the actual -base version and record the adoption date. +Create `docs/policy/oss.md` for Audita's selected grant and distribution, using +the requirements in this roadmap. Make it self-contained, with references to +Audita's canonical documents and public component sources. Record its adoption +date and appropriate policy version metadata. -The policy establishes the upstream House Format, maintenance responsibilities, +The policy establishes the House Format, maintenance responsibilities, and treatment of concrete exceptions. It identifies the settled project grant and routes readers to the canonical documents for source hosting and release publication mechanics. It does not infer separate licenses for Audita packages. -Merge the licensing-related ownership and boundary guidance from upstream -Documentation Policy 1.5 into the local documentation policy: +Add the following licensing ownership and boundary guidance to the local +documentation policy: | Document | Owned content | | --- | --- | @@ -75,9 +94,9 @@ Documentation Policy 1.5 into the local documentation policy: The contributor guide directs licensing, dependency, copied-code or asset, attribution, and release-document changes to the appropriate policy and owner. Preserve existing documentation ownership, agent commit and discovery rules, -and Audita's retirement of standalone troubleshooting documentation. Record -upstream base versions truthfully alongside repository adaptations; unrelated -upstream changes are outside this adoption scope. +and Audita's retirement of standalone troubleshooting documentation. Keep +policy version metadata accurate; unrelated policy changes are outside this +adoption scope. ### Relevant Attribution and License Texts @@ -107,7 +126,7 @@ relevant entry, including GPLv3 where an LGPLv3 entry requires it. Inspect upstr file contents rather than assuming a file named `LICENSE` contains only standard wording. -Apply the upstream house interpretation accepting direct, commit-specific links +Apply the selected house interpretation accepting direct, commit-specific links for project-specific license and attribution notice reproduction. Do not add a blanket local-copy requirement or repeated approval solely because upstream terms use reproduction, inclusion, or copy language. Preserve required notices already @@ -130,9 +149,8 @@ Audita is licensed under the [GPL v3.0 or later](COPYRIGHT). [Open Source attribution notices](docs/oss/attribution.md) are available. ``` -Merge the licensing-related guidance from upstream Release Policy 1.2 into -Audita's release policy. Each new checked-in release note and its hosted download -page ends with links visibly labeled `COPYRIGHT | LICENSE | ATTRIBUTION`. +Add the following licensing navigation requirements to Audita's release policy. +Each new checked-in release note and its hosted download page ends with links visibly labeled `COPYRIGHT | LICENSE | ATTRIBUTION`. Use absolute Gitea URLs to the three canonical files at the release's immutable tag or corresponding immutable source commit. This differs from dependency attribution links, which identify the exact imported upstream commit. @@ -184,7 +202,7 @@ Detailed implementation steps can be planned separately. ## Acceptance Criteria - Audita has an adopted OSS policy with working repository references, accurate - base-version metadata, and no leftover template setup instructions. + version metadata, and self-contained repository-specific guidance. - Documentation ownership and contributor navigation identify the canonical licensing documents without duplicating their substantive content. - Relevant incorporated and distributed components have evidence-based House diff --git a/go.mod b/go.mod index 4d272fc..bfcfa8d 100644 --- a/go.mod +++ b/go.mod @@ -3,14 +3,14 @@ module gitea.maximumdirect.net/eric/audita go 1.25.5 require ( - gitea.maximumdirect.net/eric/ConfigKit v0.4.0 - gitea.maximumdirect.net/eric/promptkit v0.11.0 + gitea.maximumdirect.net/eric/ConfigKit v0.4.1 + gitea.maximumdirect.net/eric/promptkit v0.11.1 gopkg.in/yaml.v3 v3.0.1 ) require ( - gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260922.1 // indirect - gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260922.0 // indirect + gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260926.0 // indirect + gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260926.0 // indirect github.com/kr/pretty v0.3.1 // indirect github.com/rogpeppe/go-internal v1.14.1 // indirect github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 // indirect diff --git a/go.sum b/go.sum index ea2ec17..685bce1 100644 --- a/go.sum +++ b/go.sum @@ -1,11 +1,11 @@ -gitea.maximumdirect.net/eric/ConfigKit v0.4.0 h1:fo+vKff3zTGeWqJIA38NtT84b6OUP//9ZmBH3lFuKgk= -gitea.maximumdirect.net/eric/ConfigKit v0.4.0/go.mod h1:tYWpsrbLyu05r8+1MapWp5fN6ZrX9I8hU2xEPedYmYk= -gitea.maximumdirect.net/eric/promptkit v0.11.0 h1:x7JguOUiInPVXK0GEitjyoRFqqvcuSTjYUvqJ+whtik= -gitea.maximumdirect.net/eric/promptkit v0.11.0/go.mod h1:0zEBVlJJC+ldDdXazAgybYBXNSe74vwFx5dyOuSos/w= -gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260922.1 h1:S2/Q/JDE+m8Ca3pDhAjVbfYrdlEhs9blj0STgNopHo0= -gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260922.1/go.mod h1:a3VBbh9oaGXD6ruxhtwHj+AWW6DY/SSyby1QtMmYSUo= -gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260922.0 h1:Y0EXc3eh12eKW2NrOviVqdk3oBo6UUjopt1YAa1B3Oc= -gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260922.0/go.mod h1:mtgD1E0SGm0e/I8Ffhz+AYX7GN7RKUWJXehNFIKHs4Y= +gitea.maximumdirect.net/eric/ConfigKit v0.4.1 h1:Rl2eaP5NgDgUQt8QZe0DYxF8GFc/6cnkUTLRSf5dcCU= +gitea.maximumdirect.net/eric/ConfigKit v0.4.1/go.mod h1:tYWpsrbLyu05r8+1MapWp5fN6ZrX9I8hU2xEPedYmYk= +gitea.maximumdirect.net/eric/promptkit v0.11.1 h1:fSDLdrijUi0ya4P8N4Z1g31p9LPZWVrLHVFogahUkqQ= +gitea.maximumdirect.net/eric/promptkit v0.11.1/go.mod h1:onm/FBPUKQ8/NSPwTEk26Ut+dVX2iXcq8vEseB+g/0E= +gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260926.0 h1:wdab+R+lgMZxzYwhbAuCrW7zdSQ1cW9ovBR6UzLmZR4= +gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260926.0/go.mod h1:a3VBbh9oaGXD6ruxhtwHj+AWW6DY/SSyby1QtMmYSUo= +gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260926.0 h1:baCCIB6Ee5t0S4Zc++NTBIPcJEv5UPS6DlSrpZfykwg= +gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260926.0/go.mod h1:mtgD1E0SGm0e/I8Ffhz+AYX7GN7RKUWJXehNFIKHs4Y= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI= github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=