docs: drop the em dashes and diagram how a reusable change propagates#99
Merged
Conversation
Four em dashes across the two README surfaces, rewritten rather than substituted: two became sentence breaks, one a colon, one a subordinate clause. Adds a Mermaid diagram of the propagation path, which is the thing this repository most needs a reader to understand and the hardest to carry in prose: edit, merge, prove on one consumer pinned at the merge SHA, tag only then, Dependabot bumps each consumer, and the pin moves only when that consumer's own CI passes. The red branch back to the edit is the point, because a tag is immutable and reaches every repository at once. No badge. The reader here is a maintainer deciding which version to pin, and an Actionlint status does not answer that. GitHub serves no native release badge, so there is nothing honest to add. Signed-off-by: Jaro-c <75870284+Jaro-c@users.noreply.github.com>
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.
Register sweep from ai-context#47, third of the four repos in scope.
Register
Four em dashes across
README.mdandprofile/README.md, rewritten rather than substituted — two became sentence breaks, one a colon, one a subordinate clause. No promotional vocabulary was present in either file.Diagram
A Mermaid flowchart of how a change to a reusable actually reaches a repository:
This is the single most important thing this repository needs a reader to understand, and prose carries it badly because the ordering is the whole point. The red branch back to the edit is why it is worth drawing: a tag is immutable and reaches every repository at once, so proving it on a real consumer has to happen before the tag, not after.
That ordering already exists in the CI standard and was learned the hard way (v1.9.0 was tagged straight after merge and broke every Windows consumer). Having it visible here, where the reusables live, seems worth more than another paragraph.
No badge
Deliberately. The reader of this repository is a maintainer deciding which version to pin, and
Actionlint - passingdoes not answer that question. GitHub serves no native release badge (/releases/latest/badge.svg→ 404), so there is nothing honest to put here — and a badge that does not answer the reader's question is decoration, which is the line the docs standard draws.I will fix the docs standard separately: it currently claims "GitHub-native only (workflow status, release)", and that second one does not exist.