Give the README a banner and badges, and correct what it claims - #4
Merged
Merged
Conversation
Presentation: an SVG banner and four badges. The banner is committed rather than hotlinked and is opaque rather than adaptive, because GitHub renders README images through its proxy where `prefers-color-scheme` follows the reader's operating system and not the theme GitHub is showing -- an adaptive banner is wrong for anyone with those two set differently. Its fact strip is one text element, not three positioned ones: no font is guaranteed, and the first measurement-based layout I tried overlapped the artwork in a monospace fallback. Each badge was fetched and read before being used. CI renders "passing", the Pages deployment "success", the licence "MIT", and the dependency count is a hand-maintained static badge that is true and is the point of the project. An npm version badge is deliberately absent: fitfix is not published, so it renders "package not found". Corrections, all of which had drifted: - "Three real sessions" headed a table with six rows, two of them in an 18 m pool rather than the 50 m the sentence promised. - "tuned on four files" and "four sessions from one swimmer" against seven fixtures. - The freestyle/breaststroke split was described as hard-coded at 40 strokes per length with a note that it "should be derived from the session". It has defaulted to 'auto' and scaled from the pool length since swim-05, so the paragraph described a wish that had already been granted. AGENTS.md said "It is private today" and listed two things parked until it was not, both long done. Replaced with the consequence that actually still applies: everything pushed is published immediately, including the parts that do not look like data -- a filename, a commit message, a fixture name. The H1 gives way to the banner, whose alt text carries the same words. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Warning Review limit reachedNext included review available in 23 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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 things: presentation, and accuracy. The second half is the more valuable one.
Corrections — all of these had drifted
strokeSplitdefaults toautoand scales from the pool length. The paragraph described a wish that had already been granted.And AGENTS.md still said "It is private today", listing two things parked until it wasn't — the Pages
workflow_runtrigger (live) and checkingneedles.local.jsonis untracked (it is). Replaced with the consequence that does still apply: everything pushed is published immediately, including the parts that don't look like data — a filename, a commit message, a fixture name. Which is exactly how the activity id got out last time.Banner
Committed as
.github/banner.svg, referenced by relative path. Two deliberate choices:prefers-color-schemefollows the reader's operating system, not the theme GitHub is actually showing. An adaptive banner is wrong for anyone with those two set differently.<text>element, not three positioned ones. No font is guaranteed. My first version positioned three pieces at fixed x offsets and I measured it colliding with the artwork (text ending at x=811, artwork starting at 792) in a monospace fallback. Now measured clear at 729.I also had to learn that
--is illegal inside an XML comment — the first version of the file didn't parse at all, which rendering it immediately showed. There's a note in the file for the next person, since the project's comment style uses exactly that dash.Badges
Every one was fetched and its rendered text read before use:
CI - passingsite: successruntime dependencies: 0licence: MITRejected: an npm version badge —
fitfixisn't published, so it rendersnpm: package not found. Also rejected: release badge (no releases), last-commit (showed "august" despite a same-day push).The dependency badge is hand-maintained and static, and links to the section explaining why the project has none.
Not done, on purpose
import from 'fitfix'example was left alone. It was flagged as broken; it isn't. npm workspaces symlinksnode_modules/fitfix -> packages/fitfix, so it resolves — I checked — and the README already says it's "a local module rather than a published package for now".task checkgreen: 79 tests, lint, privacy scan, build.🤖 Generated with Claude Code