The docs say what actually shipped - #101
Merged
Merged
Conversation
Four things a stranger reads first, each of them wrong. The Quickstart's one copy-pasteable line fetched v0.12.0. That is the command a reader from a package list or a forum actually runs, and it silently handed them a version two releases old, without the leak fix 0.14.1 exists for. The status line four lines above it already said 0.14.1. `CURRENT_STATE.md`, which the README sends people to for "exactly what's in progress", said the library was v0.5.0, Notary v0.3.0 and Plaza v0.2.0. Ten, seven and sixteen releases behind. It also called Notary macOS-only on the day Linux tarballs shipped, and named notifications as the next milestone when notifications have been in Plaza for months. So the version numbers come out of that file entirely. It went nine releases stale saying them, and a stale number is worse than no number: it is readable, specific and wrong. It links to each project's releases instead, which cannot drift. What stays is the description of what exists, which changes slowly. Both apps were described as macOS-only in the README's own "Built with it" section, on the day both shipped Linux builds. Also here: the em-dashes are gone from AGENTS.md and CONTRIBUTING.md, and while in AGENTS.md the dependency graph is corrected. It listed `karlseguin/websocket.zig` and `allyourcodebase/lmdb` as PLANNED. LMDB has been a real dependency since the store landed, and the websocket is not a dependency at all: `src/websocket.zig` implements RFC 6455 here, because the relay connection needs control over when a frame surfaces. The repository layout block listed three files when there are twenty-four. The CHANGELOG's em-dashes are left alone deliberately. Those entries are the published text of past releases, and editing them here would only make the file disagree with the release pages.
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.
Four things a stranger reads first, each of them wrong.
The Quickstart fetched v0.12.0. That is the one copy-pasteable line in the README, the command a reader from a package list or a forum actually runs, and it silently handed them a version two releases old without the
Relay.deinitleak fix that 0.14.1 exists for. The status line four lines above it already said 0.14.1.CURRENT_STATE.mdsaid v0.5.0 / v0.3.0 / v0.2.0. Ten, seven and sixteen releases behind, in the file the README sends people to for "exactly what's in progress". It also called Notary macOS-only on the day Linux tarballs shipped, and named notifications as the next milestone when notifications have been in Plaza for months.So the version numbers come out of that file entirely. It went nine releases stale saying them, and a stale number is worse than no number: it is readable, specific and wrong. It links to each project's releases page instead, which cannot drift. What stays is the description of what exists, which changes slowly.
Both apps were described as macOS-only in the README's own "Built with it" section, on the day both shipped Linux builds.
Also here
Fixed
AGENTS.mdandCONTRIBUTING.md, and while inAGENTS.mdthe dependency graph is corrected. It listedkarlseguin/websocket.zigandallyourcodebase/lmdbas planned. LMDB has been a real dependency since the store landed, and the websocket is not a dependency at all:src/websocket.zigimplements RFC 6455 here, because the relay connection needs control over when a frame surfaces and no client library exposed that. The repository layout block listed three files when there are twenty-four.No code changed, so no release is needed for this.