Files
promptkit/docs/roadmap/remediation.md

39 lines
1.9 KiB
Markdown

# Review Findings
Reviewed the Go example-testing migration from `7bbdb55` through `c7d4318`,
including its integration with the existing release profile. No implementation
regressions, missing migration work, or strengthened consumer contracts were
identified. The existing release validation exposed the following preexisting
documentation issue.
## 1. Repair The Historical Profile-Inheritance Link (P2)
Status: complete.
Completion: corrected the link to `#resource-inheritance`, retaining the
historical summary. ReleaseKit's complete configured candidate check passed
in the disposable checkout with the corrected document, including Markdown
validation, the race-enabled Go suite, and full vet. No release was published.
Location: `docs/releases/v0.7.0.md:129`.
The link to `../formats.md#profile-inheritance` has no matching heading in the
current format reference. That reference now documents inheritance under
`Resource Inheritance`. ReleaseKit's configured Markdown validator rejects the
candidate at this link, preventing the release check from succeeding even
though the race-enabled package suite, including all three examples, passes.
This issue predates the example-testing sprint: both the stale link and the
replacement heading are present in `7bbdb55`. Neither file changed during the
migration. It is not caused by removing the Python example hook.
Remediation: point the historical note's link to
`../formats.md#resource-inheritance`, preserving the historical release summary.
Verify the repaired link with the existing Markdown validator and complete the
normal candidate checks when preparing the release. No new gate is needed.
Evidence: a disposable clone of `c7d4318`, with only a synthetic release note
added, failed `./scripts/releasekit.sh check v0.999.0` with
`docs/releases/v0.7.0.md:129:9: heading anchor does not exist`.
Python commands were replaced by failing shims for that check; none was invoked.