README: state the current release and document the v3.3 archive peek - #3
Merged
Merged
Conversation
The front page advertised capabilities through v3.2 and named no current version, so a visitor arriving after the 3.3.0 tag saw a 3.2 page. Add a current-release line beside the CI badge, and a feature bullet for PeekScratchArchive alongside the existing version-marked entries. The current-release line also states that the (v3.0)/(v3.1)/(v3.2) markers in the feature list record when a capability landed rather than the current version, so adding a (v3.3) entry does not make the earlier ones read as stale.
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
2 participants
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.
Docs only — no code, no headers, no tests touched.
Why
After
v3.3.0was tagged, the public front page still read as a 3.2 project:PeekScratchArchiveappeared nowhere — zero hits forPeekScratchArchiveor3.3in the whole file.Net effect: a visitor arriving from an announcement reads a page advertising through v3.2, sees no release, and has to open
CHANGELOG.mdor the tag list to discover 3.3.0 exists.What changed
1. A current-release line, beside the CI badge. Placed with the badge as metadata rather than above the opening pitch, so it does not displace the lede.
It also does one thing worth calling out: it states explicitly that the
(v3.0)/(v3.1)/(v3.2)markers in the feature list record when a capability landed, not the current version. Without that, adding a(v3.3)bullet makes every older marker read as staleness, and the next reader "helpfully" bumps them.2. A feature bullet for the v3.3 archive peek. Matches the surrounding entries' voice: mechanism first, no use case sold. Covers what
PeekScratchArchivereads, that peek and load share one validator so they cannot drift, the short-span/long-span rule, and why reading a header twice beats unwinding a load.Checks run locally
Note
The current-release link points at
/releases/tag/v3.3.0, which resolves to the tag page today. If the three drafted GitHub Releases (v3.2.0, v3.2.1, v3.3.0) get cut, that same URL becomes the release page — no edit needed either way.Left unmerged deliberately — this is prose on a public surface and I wrote it, so it wants a skeptical read from someone who did not.