Skip to content

Give the README a wordmark and two diagrams - #1

Merged
CueCrux-Myles merged 2 commits into
mainfrom
readme-artwork
Aug 5, 2026
Merged

Give the README a wordmark and two diagrams#1
CueCrux-Myles merged 2 commits into
mainfrom
readme-artwork

Conversation

@CueCrux-Myles

Copy link
Copy Markdown
Contributor

Two of the README's claims are structural and read better as pictures: that every pin is resolved before a single rule runs, and that the three tiers never merge. This adds artwork for both, plus a wordmark.

The visual grammar is taken from the Crux daemon README so the two repositories read as siblings: one monospace stack, a dark panel with corner washes, glass panes with accent bars, the same accent palette. No webfonts and no external references anywhere — GitHub sanitises SVG and will not fetch one, so a linked font would silently fall back.

What is here

File
docs/Images/readme/probecrux-{light,dark}.svg The wordmark. The CRUX half is Crux's own glyph geometry translated rather than redrawn, so the two marks are identical where they overlap. PROBE is constructed to the same metrics — 699 cap height, 179-unit stem, matching optical gaps.
docs/Images/readme/how-it-works.svg acquire → pin → scan → evaluate, with the deterministic, heuristic and advisory tiers drawn as visibly separate panes. Grounded in docs/architecture.md.
docs/Images/readme/receipt.svg What the receipt attests, set against what it does not, plus the project and operator key classes.
docs/Images/readme/CueCrux-Arc-Loop{,-White}.png The arc-loop mark, copied in from the Crux repository, which is how that repo ships it.

What did not change

No existing wording. Both canonical quotes appear verbatim in receipt.svg and remain in the prose, so neither the manifest wording nor a text search for it depends on an image. The status warning and the pre-1.0 rule-identifier warning keep their position directly beneath the hero — the hero does not bury them.

Worth a look while reviewing

  • There is no NOTICE file. Crux's carries a trade-marks clause covering these marks. This PR does not add one; it probably should exist before the repository gets much public traffic. Happy to add it here or separately.
  • The two diagrams are dark-panel regardless of the reader's GitHub theme, which is what the Crux README does. Only the wordmark and the arc-loop mark switch on prefers-color-scheme.
  • The wordmark renders at width="339", which puts its cap height at roughly 36 px — the same optical size as CRUX at Crux's width="216".

How it was checked

Every file was rendered in headless Chromium and inspected at size, in both GitHub themes. That pass caught two defects worth naming: the P was derived from the R and kept the point where the leg springs off, leaving a spur and a sloped bowl underside; and an earlier revision routed a wire through two of the tier panes. Both are fixed here.

The SVGs were drafted with GPT-5.6 against an extracted style contract, then reviewed and corrected by hand — the two defects above were found and fixed in review, not by the generator.

🤖 Generated with Claude Code

CueCrux-Myles and others added 2 commits August 5, 2026 13:45
The README argued for reproducibility in prose alone. Two of its claims are
structural and read better as pictures: that every pin is resolved before a
single rule runs, and that the three tiers never merge.

Adds four hand-authored SVGs under docs/Images/readme/, following the visual
grammar already established by the Crux daemon README so the two repositories
read as siblings — one monospace stack with no webfonts, since GitHub sanitises
SVG and will not fetch one; a dark panel with corner washes; glass panes with
accent bars; and the same accent palette throughout.

  probecrux-{light,dark}.svg  the wordmark. The CRUX half is Crux's own glyph
                              geometry translated rather than redrawn, so the
                              two marks are identical where they overlap; PROBE
                              is constructed to the same metrics (699 cap
                              height, 179-unit stem).
  how-it-works.svg            acquire, pin, scan, evaluate, with the
                              deterministic, heuristic and advisory tiers drawn
                              as visibly separate panes.
  receipt.svg                 what the receipt attests set against what it does
                              not, plus the project and operator key classes.

Both canonical quotes are reproduced verbatim in receipt.svg and left in the
prose as well, so neither the manifest wording nor a text search for it depends
on an image.

No existing wording changed. The status and pre-1.0 rule-identifier warnings
keep their position directly beneath the hero.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The manifest holds eighteen rules, fifteen of them deterministic. The README
still said seventeen and fourteen, and the previous commit hardened that into
two SVGs — where it costs an image re-export to fix rather than a one-line
edit. Corrected in the hero, the rule-set section, the tier table, the pipeline
diagram and its alt text.

The drift predates this branch: R018 was minted and R004 widened without the
README following. Nothing tests the README's counts against the parsed
manifest, which is precisely the failure R002 exists to detect — a document
that has drifted is worse than no document, because it tells a reader the work
was done. `crates/probecrux-manifest/tests/rules_manifest.rs` already asserts
18 and 15; only the prose was unguarded.

Also corrects `docs/architecture.md`, which counted fourteen deterministic
rules in its v1-scope section. Its per-rule ordering and deferral lists are
left alone — those are scope decisions, not a count, and are not mine to guess
at.

receipt.svg was rendering `does_not_attest` without its last two sentences —
"ProbeCrux reports findings for triage. It does not issue assurance." Those
are the two doing the heaviest lifting, one naming what the tool is and the
other the strongest disclaimer in the project, and a diagram is the worst place
to shorten a string the manifest requires verbatim. Both panels are rewrapped
to a common measure; the full wording now fits without changing the layout, and
the aria-label carries it too.

The pipeline diagram's badge now reads "no network during evaluation" rather
than "no network during a run". Since D023 the container makes two calls around
evaluation for the hosted input path, and it ships curl to do it. The narrower
claim is the one that survives someone reading the Dockerfile.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@CueCrux-Myles

Copy link
Copy Markdown
Contributor Author

Pushed 0bd420e. All three points addressed.

Counts. Verified against origin/main:probecrux.rules.yaml before editing rather than taking the numbers on trust — 18 ids, tier split 15 / 2 / 1, deprecated_rules empty. Corrected in all five places: hero, rule-set section, tier table, the 18 rules · 3 tiers chip, the 15 rules deterministic pane, and the diagram's alt text.

One place beyond your list had the same drift: docs/architecture.md opened its v1-scope section with "Fourteen rules are marked deterministic". Fixed, since the consistency test you're planning would trip on it. I left that section's per-rule ordering and deferral lists alone — those are scope decisions rather than a count, and R018 and the widened R004 may or may not belong in them. That's a call for you, not a guess for me.

does_not_attest. Restored in full, verbatim from receipt_binding. Both panels are rewrapped to a common measure so the two extra sentences fit inside the existing panel height — no layout change, no re-export of anything else. The aria-label carries the complete wording too, which it previously did not, so a screen-reader user was getting the truncation as well.

Worth noting the same shape exists in the README prose and I have not touched it: the ## What the receipt does not attest blockquote stops at "outside the scope of these rules", and "ProbeCrux reports findings for triage. It does not issue assurance." follows as a separate paragraph. Every word is present and in order, so a reader loses nothing — but the blockquote alone is not the verbatim string, and if a test asserts the canonical wording appears as one block it will fail there. Your call whether that is a defect or a deliberate split.

D023. Badge now reads no network during evaluation. You were right that it needed care rather than a change of substance — the chip widened by 43px to fit and nothing else moved.

The test. Leaving it to you as you said you'd add it at merge, so we don't both write it. If you'd rather I did, say so.

Both diagrams re-rendered in headless Chromium and checked at size after the edits.

@CueCrux-Myles
CueCrux-Myles merged commit bf384b6 into main Aug 5, 2026
5 checks passed
@CueCrux-Myles
CueCrux-Myles deleted the readme-artwork branch August 5, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant