docs: fix README consumer on-ramp (host + fonts); fold tracking into WP-0003 T06
- README: correct the Node-tooled install host (placeholder gitea.example.com → gitea.coulomb.social/coulomb/whynot-design) and rewrite the Type/font prose to match the actual tokens (system font stacks, no webfont; Plex kept as history). - WHYNOT-WP-0003 T06: add a "Tracking whynot-design from a consuming repo" README section (pin → inspect → drift → adopt) and reconcile the install pin once T01/T02 publish a tag. - Record the README fixes as ADHOC-2026-06-27. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
16
README.md
16
README.md
@@ -39,7 +39,7 @@ Framework-agnostic by design. Consumers do **not** re-implement components per f
|
||||
### Node-tooled consumer (React, Vite, Next, Vue, …)
|
||||
|
||||
```sh
|
||||
pnpm add git+ssh://git@gitea.example.com/whynot/whynot-design.git#v0.2.0
|
||||
pnpm add git+ssh://git@gitea.coulomb.social/coulomb/whynot-design.git#v0.2.0
|
||||
```
|
||||
|
||||
```js
|
||||
@@ -202,7 +202,7 @@ The system reads like **engineering graph paper** — precise hairlines, lots of
|
||||
|
||||
### Type
|
||||
|
||||
- **Family**: `IBM Plex Sans` for everything UI/body. `IBM Plex Mono` for labels, code, and stage markers. `IBM Plex Serif` for the occasional editorial pull-quote. (See font substitution note in *Fonts* below.)
|
||||
- **Family**: native system stacks — `--ff-sans` (`ui-sans-serif, system-ui, …`) for UI/body, `--ff-mono` (`ui-monospace, …`) for labels, code, and stage markers, `--ff-serif` (`ui-serif, Georgia, …`) for the occasional editorial pull-quote. **No webfont is loaded.** (See font note below for the history.)
|
||||
- **Weights**: 300 (display only), 400 (body), 500 (UI / headings), 600 (occasional emphasis). Never 700+ — too marketing.
|
||||
- **Tracking**: tight on display (`-0.035em`), neutral on body, **wide on uppercase labels** (`0.08em` — this is the one signature move).
|
||||
- **Eyebrows everywhere**: short uppercase mono labels above titles (`STAGE`, `SIGNAL`, `PROTOTYPE`). They are the system's main rhythmic element.
|
||||
@@ -340,14 +340,8 @@ These are allowed and preferred over raster icons in some contexts:
|
||||
|
||||
---
|
||||
|
||||
## A note on font substitution
|
||||
## A note on fonts
|
||||
|
||||
The control repo did not ship font files. **IBM Plex Sans / Mono / Serif** were chosen as a fresh pairing because:
|
||||
The token layer uses **native system font stacks** — `--ff-sans` (`ui-sans-serif, system-ui, …`), `--ff-mono` (`ui-monospace, …`), `--ff-serif` (`ui-serif, Georgia, …`). **No webfont is loaded.** These stacks were synced from the canonical React designbook (WHYNOT-WP-0002 T06); they keep the neutral, technical-document feel while staying offline-safe and dependency-free.
|
||||
|
||||
- The "Plex" family was designed by IBM as an explicitly *neutral, technical-document* family — the same use-case as this system.
|
||||
- All three (sans, mono, serif) share metrics, so they mix cleanly in templates and tables.
|
||||
- They are openly licensed (SIL OFL) and available on Google Fonts.
|
||||
|
||||
Plex is currently loaded from Google Fonts (see top of `colors_and_type.css`). For offline use, drop the `.woff2` files into `fonts/` and swap the `@import` for a local `@font-face` block.
|
||||
|
||||
> **🟨 Substitution flagged**: there was no specified brand font; IBM Plex is a choice made here. If `whynot` later adopts a different brand font, replace `--ff-sans` / `--ff-mono` / `--ff-serif` in `colors_and_type.css` and everything downstream will follow.
|
||||
History: **IBM Plex Sans / Mono / Serif** was the earlier pairing — a neutral IBM technical-document family with shared metrics across sans/mono/serif, SIL OFL, available on Google Fonts. It was dropped in favour of system stacks. To reintroduce a brand webfont, add an `@font-face` block and point `--ff-sans` / `--ff-mono` / `--ff-serif` at it in `colors_and_type.css` — everything downstream follows.
|
||||
|
||||
38
workplans/ADHOC-2026-06-27.md
Normal file
38
workplans/ADHOC-2026-06-27.md
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: ADHOC-2026-06-27
|
||||
type: workplan
|
||||
title: "Ad hoc fixes — 2026-06-27"
|
||||
domain: infotech
|
||||
repo: whynot-design
|
||||
status: active
|
||||
owner: claude
|
||||
topic_slug: custodian
|
||||
created: "2026-06-27"
|
||||
updated: "2026-06-27"
|
||||
---
|
||||
|
||||
# Ad hoc fixes — 2026-06-27
|
||||
|
||||
Low-risk opportunistic fixes completed directly during the WHYNOT-WP-0003 session.
|
||||
|
||||
## README consumer-onboarding accuracy
|
||||
|
||||
```task
|
||||
id: ADHOC-2026-06-27-T01
|
||||
status: done
|
||||
priority: medium
|
||||
```
|
||||
|
||||
Two staleness fixes in `README.md` found while reviewing the consumer on-ramp:
|
||||
|
||||
- **Quick-start install host** — the Node-tooled install line used the placeholder
|
||||
`gitea.example.com/whynot/...`; corrected to the real remote
|
||||
`gitea.coulomb.social/coulomb/whynot-design`. (The `#v0.2.0` pin is intentional but
|
||||
only resolves once WHYNOT-WP-0003 T01 cuts the tag.)
|
||||
- **Font prose** — the Type section and font note still described `IBM Plex` loaded
|
||||
from Google Fonts, contradicting the actual tokens, which switched to system stacks
|
||||
(`ui-sans-serif`/`ui-monospace`/`ui-serif`) in WHYNOT-WP-0002 T06. Rewrote both to
|
||||
state the current reality (no webfont loaded) and keep the Plex rationale as history.
|
||||
|
||||
Deeper consumer-tracking docs (pin → inspect → drift loop) are folded into
|
||||
WHYNOT-WP-0003 T06, not here.
|
||||
@@ -194,6 +194,15 @@ example consuming-repo fixture under `examples/` (or `docs/`) that exercises the
|
||||
loop against a fixed version, so the workflow is copy-pasteable. Cross-link from
|
||||
`README.md` and `MultiFrameworkSupport.md`.
|
||||
|
||||
As part of this task, add a **"Tracking whynot-design from a consuming repo"**
|
||||
section to `README.md` (next to *Quick start*) — the README currently documents only
|
||||
*component usage*, not how a consumer pins a version, inspects it (`ir/INDEX.md` /
|
||||
`ir/manifest.json`), runs `drift`, and adopts the new sync-point at its own pace.
|
||||
Point it at the full guide above. While there, finish the install-line correctness
|
||||
the 2026-06-27 adhoc started: the `pnpm add …#v0.2.0` pin only resolves once T01 has
|
||||
cut the tag and T02 has published, so reconcile the README to the real, tagged
|
||||
registry coordinates as those land.
|
||||
|
||||
---
|
||||
|
||||
## Phase 3 — Inspectability
|
||||
|
||||
Reference in New Issue
Block a user