Repository navigation
docs: add release step checking homepage claims against CHANGELOG - #515
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What Changed
docs/RELEASING-docs-checklist.md: adds a checklist item to diff the release's user-visibleCHANGELOG.mdentries against the homepage's prose claims inwww/index.html("What fails the build", "Who it's for", "Using it with the ORM you have", and the help-section gaps list). Notes that a stale claim becomes a PR on the site repo, which merges only on a maintainer's word.docs/RELEASING.md: adds a step after version propagation in the release procedure that points to that checklist item.Validation
Risk Assessment
✅ Low: Docs-only change adds a release checklist item and a pointer in RELEASING.md; the §B cross-reference resolves, no public-hygiene violations, and it matches the intent's recommended release step.
Testing
Pipeline
Updates from git push no-mistakes
✅ **Intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
✅ **Review** - passed
✅ No issues found.
⏭️ **Test** - skipped
Step was skipped.
⏭️ **Document** - skipped
Step was skipped.
⏭️ **Lint** - skipped
Step was skipped.
✅ **Push** - passed
✅ No issues found.