eric/ReleaseKit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Align module release documentation with implemented behavior

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-10 14:36:56 +00:00
parent 8112a001d2
commit 6b0b8ce6de
11 changed files with 96 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/roadmap/remediation.md
View File

@@ -1,7 +1,7 @@
# Remediation: module release implementation review
Status: open findings from review of `90559fe`, compared with planning baseline
`dbfae9e`.
Status: complete; all eleven findings addressed and verified. The review examined
`90559fe`, compared with planning baseline `dbfae9e`.
## Scope and evidence
@@ -20,7 +20,7 @@ bare repository. No ReleaseKit source or real release refs were changed.
Each issue describes required work and verification. Preserve the selected
scope, existing error causes, publication/delivery outcomes, facade boundaries,
and clean API cutover. These corrections add no release, live-service, or human
review gates. Add focused completion markers as issues are resolved.
review gates. Each completion record describes the correction and verification.
## Issue 1: Resolve the actual Git repository root before release identity (P1)
@@ -366,7 +366,18 @@ or new validation policies.
## Issue 11: Reconcile documentation with implemented scope and status (P3)
Status: open. Category: incomplete documentation adoption and misleading contracts.
Status: complete. Category: incomplete documentation adoption and misleading contracts.
**Completion:** Facade GoDoc and canonical API, CLI, configuration, Gitea, and
internal guidance describe selected inputs, full-tag uniqueness, module-local
notes, shared-file scope, committed references, and lazy Go reuse consistently.
The feature roadmap identifies its historical baseline and completed stages,
with this review recording the corrections. Consumer-owned license layouts and
note links are distinguished from optional validation defaults. ReleaseKit's
root release policy and procedure retain their existing requirements. Reviewed
root/nested examples, verified local links/fragments across 37 Markdown documents,
checked example JSON/shell syntax and whitespace, and passed the final complete
offline suite and compiled API/dependency checks.
**Evidence:**