Reorder and tighten the unreleased changelog#487
Merged
Conversation
Entries that affect every user now come before the hosted OAuth proxy ones, which only reach deployments running that proxy. Section order is unchanged, and Breaking changes stays first. The prose pass removes em-dash asides, leads each entry with the observable change rather than the mechanism, and gives the three proxy entries that did not identify their scope the same prefix as their siblings.
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.
Two passes over the
[Unreleased]section: reorder by audience, then tighten the prose. No entry was added or removed, and no factual claim changed.Reorder
Of the eight
Addedentries, six applied only to deployments running the hosted OAuth proxy, yet they led the section. Entries that reach every user now come first in each subsection:-ychange, then proxy sign-in persistence.Keep a Changelog section order is unchanged.
Breaking changesstays first even though its single entry is proxy-specific, since a breaking change should stay prominent regardless of who it reaches.Writing pass
Against the
CHANGELOGgenre indocs/documentation-conventions.md(reader: users deciding whether to upgrade; observable behaviour, no internal jargon):Hosted OAuth proxy:prefix their siblings already carried (the consent page, IPv6 loopback, and the loopback-variable-port fix), so an entry's audience is visible without reading it in full. Each was verified proxy-specific against the source rather than assumed.Verification
handleListenErrorhas a third branch.🤖 Generated with Claude Code