design: correct the ring, lead the badges with the licence, lock up the masthead - #54
Merged
Merged
Conversation
Two independent problems, both visible at README size. Round caps ate the gap. stroke-linecap="round" extends stroke-width/2 along the tangent past each endpoint — 12.7° at r=13.5, sw=6 — so the 34° gap in the source rendered as 8.5° on screen. The ring read as a nearly-closed progress spinner rather than four separated arcs. The ramp's first two stops sat adjacent. #3c8cff and #0095fd are near-identical blues; side by side on a ring they merge into one lump split by a hairline while cyan and green stay distinct opposite them, so the mark was visibly heavier on one half. Arcs now span 42.6° with a 47.4° geometric gap, which measures 22° on screen once the caps are counted, and the ramp runs blue / cyan / blue / green so the two blues sit opposite. Sequence order is dropped deliberately: a ring has no first stop, so ordering for balance costs nothing a reader could have used. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 48 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe README now uses a combined RSIHub lockup and an Apache-2.0 license badge. The documentation index records the lockup and retained lineage figure. Repository tests validate the updated SVG assets, ring-mark geometry, and dark-mode styling. ChangesRSIHub branding lockup
Estimated code review effort: 2 (Simple) | ~10 minutes Mergeability Score: ⚪ Minimal · up to This PR updates branding assets, badge ordering, masthead composition, and documentation references without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review. Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
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 |
Octane0411
force-pushed
the
design/baseline-ring-and-lineage
branch
from
August 12, 2026 09:26
e8624ba to
3fb41f1
Compare
Octane0411
changed the title
Octane0411
changed the title
Apache-2.0 moves to the front. It is the one fact in this row a reader comparing frameworks cannot skip, and it was sitting third in shields' default blue — a colour close enough to the ramp to read as unchosen rather than different. Now #0095fd with the OSI mark. The documentation badge is gone. It pointed at the docs site, which the Documentation section already links in its first row, and the navigation strip sits directly beneath the badges — three routes to one destination inside two screen inches. What is left answers three questions in descending order of how hard they block: may I use this, does it work, will it run here. Python keeps #3776AB, the language's own brand colour, where changing it would cost recognition for nothing. Nothing was added. Version, downloads and release badges would all be untrue today: rsihub is not on PyPI and the repo has no releases. No coverage tooling is configured, and there is no paper to cite. A headline benchmark number would be worse than untrue — the sealed split is where this framework's gains stop, and that is the finding, not a thing to paper over with a chip. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Octane0411
force-pushed
the
design/baseline-ring-and-lineage
branch
from
August 12, 2026 09:39
45d589a to
032a105
Compare
Two <img> tags side by side in a README align on the text baseline rather than on each other, and GitHub strips the attributes that would correct it — so a mark-left, wordmark-right composition has to be one file to hold its proportions. docs/rsihub-lockup.svg welds them together. Everything is derived from the mark box so the lockup scales as one object: cap height at 0.50 of the box, gap at 0.36, and the wordmark's cap height centred on the mark's centre rather than sharing a baseline — a ring has no baseline to share. The wordmark's own style block travels with it, so the prefers-color-scheme switch that keeps RSI legible on both grounds survives the merge. The lineage figure is out of the README. It was still drawn in the retired forest-green palette, which read as an accident once the mark and wordmark above it were both on the ramp, and on a dark ground it floated as a mint card on a dark page. The file stays on disk and under test: the composition it draws is still the right one, and it can come back once it is redrawn on the ramp — which is not a recolour, because the ramp's own stops fail this repo's 3:1 floor against any light ground. Both parts also stay on disk because mkdocs takes the mark for its logo and favicon. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Octane0411
changed the title
The masthead read as crowded next to comparable projects, and the cause was three separate things rather than one. The lockup was too small. At 520px it now occupies roughly the share of the column that reads as a masthead rather than a header image. There was no whitespace anywhere. Six centred blocks sat at markdown's default 16px apart, and a README cannot carry CSS margins, so the air has to come from somewhere explicit. Two places, and both are used here: the lockup's viewBox carries 0.45 of the mark box as padding on every side, so the file brings its own room wherever it is placed, and <br> separates the masthead blocks. Verified against GitHub's own markdown renderer that the breaks survive sanitising rather than assuming they would. The benchmark figure stays where it is. It is the densest graphic in the repo and it lands immediately under the navigation strip, which is most of what made the fold feel tight — but it is also the strongest evidence this project has, and burying it below the fold to win whitespace is the wrong trade. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The previous pass stacked two independent sources of whitespace — padding baked into the lockup's viewBox and <br> between every block — and they compounded. The gap between the lockup and the tagline came to roughly 106px, and because every gap was the same size the result read as loose rather than structured. Whitespace is hierarchical now. The air sits around the lockup, where it does the work of making the mark read as a masthead, and the text blocks below it close back up to markdown's own spacing. Only one break survives, between the navigation strip and the benchmark figure, which is the one place two different kinds of content meet. Sized against a real constraint rather than taste: the benchmark figure is 1600x790, so it renders about 425px tall at GitHub's content width, and the masthead has to come in under roughly 375px for both to land above the fold on a normal window. Lockup padding at 0.30 of the mark box and 460px wide gets there with the whole figure visible, legend included. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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
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.
Three brand surfaces: the ring's geometry, the badge row, and the masthead composition.
The ring was drawn to the wrong numbers
Two independent faults, both visible at README size.
Round caps ate the gap.
stroke-linecap="round"extendsstroke-width/2along the tangent past each endpoint — 12.7° atr=13.5, sw=6. The source asked for a 34° gap and the screen showed 8.5°. The mark read as a nearly-closed progress spinner rather than four separated arcs. Arcs now span 42.6° with a 47.4° geometric gap, which measures 22° on screen once the caps are counted.The two blues sat adjacent.
#3c8cffand#0095fdare near-identical. Side by side on a ring they merge into one lump split by a hairline, while cyan and green stay distinct opposite them — so the mark was visibly heavier on one half. The ramp now runs blue / cyan / blue / green so the two blues sit opposite.Sequence order is dropped on purpose: a ring has no first stop, so ordering the ramp for balance costs nothing a reader could have used. That reasoning does not carry to figures that read left to right, where the ramp should stay in sequence.
The badge row leads with the licence
Apache-2.0 moves to the front — the one fact in that row a reader comparing frameworks cannot skip, and it was sitting third in shields' default blue, a colour close enough to the ramp to read as unchosen rather than different. Now
#0095fdwith the OSI mark rather than the Apache feather, which would imply an ASF affiliation this project does not have.The documentation badge is gone: it pointed at the docs site, which the Documentation section already links, and the navigation strip sits directly beneath the badges. What is left answers three questions in descending order of how hard they block: may I use this, does it work, will it run here. Python keeps
#3776AB, the language's own colour.Nothing was added — version, downloads and release badges would all be untrue today, since
rsihubis not on PyPI and the repo has no releases.The masthead is one lockup, mark left and wordmark right
Two
<img>tags side by side align on the text baseline rather than on each other, and GitHub strips the attributes that would correct it, so this composition has to be a single file to hold its proportions.docs/rsihub-lockup.svgwelds them together.Everything derives from the mark box so the lockup scales as one object: cap height at 0.50 of the box, gap at 0.36, and the wordmark's cap height centred on the mark's centre rather than sharing a baseline — a ring has no baseline to share. The wordmark's own
<style>block travels with it, so theprefers-color-schemeswitch that keeps RSI legible on both grounds survives the merge.Both source assets stay on disk; mkdocs takes the mark for its logo and favicon.
The lineage figure is out of the README
It was still drawn in the retired forest-green palette. That read as an accident once the mark and wordmark above it were both on the ramp, and on a dark ground it floated as a mint card on a dark page.
The file stays on disk and under test. The composition it draws is still the right one and it can come back once it is redrawn — but that is not a recolour job: against any light ground the ramp's own stops fail the 3:1 floor this repo asserts, with
#00cbd4at 1.90:1 and#78e85cat 1.48:1 on#f2fbf7, and only#3c8cffclearing the bar. That constraint, not preference, is what put the figure in green in the first place, and whoever redraws it has to answer it.Checks
Not in this PR
docs/assets/architecture.svgis still entirely in the retired green and is pinned to that palette bytest_architecture_visual_uses_identity_palette. Same contrast constraint applies; worth its own review.🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Tests