docs: ship the full brand kit and polish the book theme - #307
Conversation
Puts every brand asset in the repo so they are public and viewable, and
makes the docs site and README feel finished.
- assets/brand/: the complete export is now checked in — svg/ + png/
(all 14 vectors/rasters), mockups/ (brand-board renders incl. the
construction-grid mark and the signage mockup), and source/
(Plumb.ai/.eps/.pdf). BRAND.md is now a viewable gallery + manifest.
- New blueprint-grid social card (assets/brand/plumb-og.{svg,png}) and a
square gridded mark (plumb-social-square.*) — the white logo now sits
on the brand-blue construction grid instead of a flat field. The docs
Open Graph card uses it.
- docs book theme matches the brand: a theme-aware lockup hero on the
landing page (light/dark swap), the app-icon mark beside the menu
title, and the favicon remains the blue app icon (mdBook injects it;
it shows once the Pages site redeploys).
- README leads with the gridded brand banner.
The docs site only redeploys on release: published, and a
GITHUB_TOKEN-cut release does not fire that event — so the live
favicon/theme lag until `pages.yml` is dispatched.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
I have enough information to write the review. This is a pure docs/brand PR — no Rust source changes at all. PR #307 — docs: ship the full brand kit and polish the book themeCrates touched: 1. Determinism invariantsN/A — no Rust code. 2. Workspace layeringN/A — no Rust code. 3. Error handlingN/A — no Rust code. 4. Test coverageN/A — no public API added. 5. Documentation quality
Humanizer check — README.md — The Punch list
No blockers. The deprecated attribute and missing newlines are the only substantive findings. Verdict: APPROVE |
1 participant
Context
Follow-up to the brand work: put every asset in the repo so it's public and viewable, fix the favicon situation, and make the GitHub/docs surfaces feel finished — using the blueprint-grid aesthetic from the brand board (the white mark on brand-blue with a construction grid), not a flat logo.
What changed
assets/brand/{svg,png,mockups,source}/: all 14 vectors + rasters, the brand-board renders (incl. the construction-grid markPlumb-11.jpgand the signage mockup), and the editablePlumb.ai/.eps/.pdf.BRAND.mdis now a viewable gallery + manifest.assets/brand/plumb-og.{svg,png}(white lockup on the brand-blue grid + a 45° set-square construction line) and a squareplumb-social-square.*. The docs Open Graph card now uses the gridded version.On the favicon / "white logo on GitHub"
The docs site only redeploys on
release: published, and aGITHUB_TOKEN-cut release doesn't fire that event — so the live site still shows the pre-brand favicon. After this merges I'll dispatchpages.ymlto deploy. For the repo social preview (Settings → General → Social preview), uploadassets/brand/plumb-og.png— GitHub's repo card can't be set via API.Closes the favicon polish;
mdbook build+cargo docverified locally. (npm re-publish tracked in #306.)🤖 Generated with Claude Code