docs: write changelog sections as short bullets - #279
Merged
Conversation
The 1.4.2 section was four paragraphs plus two sub-sections; the release page and the site show it verbatim, and nobody reads that. It becomes a one-line summary and short bullets, keeping the sentences the release metadata test and the site's release contract pin (the host/client boundary, Steam Input staying manual and read-only, the signed three-ABI APKs). The Unreleased entries take the same shape.
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
1 participant
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.
Summary
Changelog sections become short bullets; the 1.4.2 section and the Unreleased entries are rewritten in that shape. The release page shows the section verbatim through
scripts/extract_release_notes.py, and the site publishes it byte for byte, so this is what people read.## 1.4.2 - 2026-09-04: one-line summary plus seven bullets (per-game encoder choice, remembered per game, SHM as topology, host owns policy, Steam Input unchanged, version bump, signed APKs). The sentences pinned byNovaReleaseMetadataTestand the site's release contract are kept verbatim inside the bullets.## Unreleased: the two pending entries as bullets.Exact candidate
Commit:51ccb473ea5ce2d6154f9ee4329857e881a6b6b1Tree:8aa673f6da55b67089440481091974062404f00fParent:8f0cac542d92fd6e343800ad8c0b178498879746Base:8f0cac542d92fd6e343800ad8c0b178498879746Verification
NovaReleaseMetadataTest: 3/3 (JUnit report on disk)python3 scripts/extract_release_notes.py v1.4.2: extracts the new section cleanlybash scripts/check-public-docs.sh,bash scripts/check-public-surface.sh,git diff --check: cleanFollow-ups after merge:
gh release edit v1.4.2with the extracted section, and the site PR that re-pins the Nova notes page.