Repository navigation
docs: say what a version mark is for, then how it works - #16
Merged
Merged
Conversation
The README explained the machinery first: entropy streams, the perceptual hash, the threshold suite. All of that is why the library can be trusted, but none of it is why anyone would reach for it, and a reader who wanted to know whether this solves a problem they have had to get through three sections to find out. So the README now opens on the problem. Version numbers are hard to see: 1.4.12 and 1.4.2 differ by one character in the middle of a string. A mark either looks the same or it does not. That buys spotting the odd row in a release table, showing a version in a UI that shows no version — a favicon or a corner glyph that makes a screenshot in a bug report name its own build — confirming that the artifact, the health page and the release notes agree, and a release people remember as a picture. The machinery moves to docs/how-it-works.md, the endpoint to docs/service.md, and the renderer table to docs/renderers.md, which also gains a column saying which renderers can be read back. The gallery markers move with that table, so the generator's -readme flag now points there; it writes image links relative to the file it rewrites, so the paths came out right on their own. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019RJ8FUiT1YvbBz3D2PriM9
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.
The README led with machinery — entropy streams, the perceptual hash, the threshold suite. That is why the library can be trusted, but it is not why anyone would reach for it, and a reader had to get through three sections to find out whether it solves a problem they have had.
README (286 → 100 lines)
Opens on the problem instead.
1.4.12and1.4.2differ by one character in the middle of a string; a mark either looks the same or it does not. Four uses follow from that:Then the two enforced properties in a line each (neighbours never confusable; family resemblance is a setting, not an accident of a hash), the three ways to use it, and a link list.
Moved to
docs/docs/how-it-works.mddocs/renderers.mddocs/service.mdGallery plumbing
The gallery markers moved with the renderer table, so
-readmenow points atdocs/renderers.mdin the workflow, the PR template andCONTRIBUTING.md. The generator writes image links relative to the file it rewrites, so the paths came out asgallery/*.pngwithout a code change.Regenerated twice: no image diff, second run is a no-op.
go test ./cmd/blazonpasses.CONTRIBUTING.mdgains a step for the new table row.🤖 Generated with Claude Code
https://claude.ai/code/session_019RJ8FUiT1YvbBz3D2PriM9