Skip to content

docs: rebuild the site illustrations in the ISCC identity - #135

Merged
titusz merged 3 commits into
mainfrom
docs/brand-illustrations
Sep 21, 2026
Merged

titusz merged 3 commits into
mainfrom
docs/brand-illustrations

Conversation

@titusz

@titusz titusz commented Sep 21, 2026

Copy link
Copy Markdown
Member

Summary

Replaces the three pre-2026 illustrations (Google Drawings exports with navy header bands, Google blue and cyan, red and green status colours, outlined text) with figures built to the Edition 01 identity, following the direction of the ISCC brand agent: white field, near-black text and connectors, thin rules, square corners, coral as the single emphasis, the fixed ISCC-UNIT colours wherever a unit is named, curated Carbon icons, Readex Pro and JetBrains Mono.

The figures are generated by scripts/gen_figures.py (run with uv run --group figures python scripts/gen_figures.py). Text is outlined from the theme's own WOFF2 fonts, so the SVGs render identically as <img>, in the lightbox and in any converter. File names and URLs are unchanged. All ISCC codes shown are genuine and were verified with iscc-core.

File Shows Used on
iscc-algo-design3.svg Metadata, normalized content and raw bytes feed the five ISCC-UNITs (page 14 unit row, unit strings inside), which combine into one ISCC-CODE. Semantic-Code marked as reserved. Overview, Capabilities
iscc-similarity-hash.svg The bitwise majority vote, counts computed from the rows Legacy specification
iscc-decentralized-issuance.svg Author, Publisher, Library, Anyone calculate the same code from the same file. "Calculated, not assigned." Capabilities
iscc-similarity-comparison.svg (new, second commit) Original PNG vs. a 2 % cropped JPEG copy: Content-Codes differ in 6 of 64 bits (close), Data-Codes in 36 (far apart), Instance-Codes have no exact match Capabilities

The second commit swaps the Capabilities similarity section from the majority-vote figure to the new comparison figure, which matches the text beside it. Drop that commit if you prefer to keep the old subject there.

Previews

ISCC-CODE structure

Comparing ISCC-UNITs

Calculated, not assigned

Similarity hash

Decisions to review

  • Outlined text instead of live text or inline SVG: inline SVG would end up in the copy-page Markdown and llms-full.txt; embedded fonts add about 70 KB per figure. The generator is the editable source; no .editable.svg is shipped.
  • No dark variants (brand guidance: technical diagrams stay on pale fields). On the slate scheme the white field reads as a card without extra CSS.
  • Alt texts now state each figure's point.

Not in this PR

  • The other legacy specification figures (iscc-creation-process.svg, iscc-pcf.svg, iscc-creation-instance-code.svg) are still in the old style; they document the v1.x draft and were left as they are.
  • Unreferenced files in docs/images/ (iscc-algo-design.svg, iscc-algo-design2.svg, iscc-web-demo.svg, iscc-image-clustering.svg, iscc-badge.svg, retired logo PNGs) are untouched.
  • Capabilities floats figures at 50 % of the column, which makes them thumbnails until opened in the lightbox. That layout is unchanged.

Validation

prek run --all-files (stamp updated), check_site_paths.py, zensical build --clean, gen_markdown_pages.py, check_site_paths.py --site-dir site all pass. Both colour schemes checked in the browser.

Merge note: a parallel branch (Privacy Badger third-party fixes) also touches docs/license.md; whichever merges second needs the stamp hook rerun.

Replace the three Google Drawings exports (old navy header bands, Google blue
and cyan, red and green status colours, outlined text) with figures generated
by scripts/gen_figures.py following the Edition 01 identity: white field,
near-black text and connectors, thin rules, square corners, coral as the single
emphasis, the fixed ISCC-UNIT colours where a unit is named, and curated Carbon
icons. Text is set in Readex Pro and JetBrains Mono and outlined from the theme
fonts, so the SVGs render the same everywhere without font loading.

- iscc-algo-design3.svg: metadata, normalized content and raw bytes feed the
  five ISCC-UNITs (with a genuine image ISCC-CODE), which combine into one
  ISCC-CODE; Semantic-Code marked as reserved.
- iscc-similarity-hash.svg: the bitwise majority vote, with counts computed
  from the input rows.
- iscc-decentralized-issuance.svg: author, publisher, library and anyone
  calculate the same code from the same file: calculated, not assigned.

File names and URLs are unchanged. Alt texts now state each figure's point.
The figures dependency group adds fonttools and brotli for regeneration.
The similarity section showed the majority-vote similarity hash, which belongs
to the legacy v1 specification and does not illustrate the text beside it. Add
iscc-similarity-comparison.svg: an original image and a copy trimmed by 2 % and
re-compressed as JPEG, with the 64-bit bodies of their Content-, Data- and
Instance-Codes side by side and every differing position in coral. The codes
are genuine, computed with iscc-core, and the verdicts follow the brand
wording: 6 of 64 bits differ (close), 36 of 64 bits differ (far apart), no
exact match. The legacy specification keeps the rebuilt majority-vote figure.
- Comparison figure: no coral position marks on the Instance-Code rows; a
  checksum is matched exactly or not at all, so a bit distance means nothing
  there. Add the caption that explains why the Data-Code moves far apart while
  the perceptual Content-Code stays close.
- Calculated-not-assigned figure: reference the standard as ISO 24138:2024.
- Generator: verify with iscc-core that the ISCC-CODE decomposes into the shown
  units and that the comparison codes are 64-bit units; derive the comparison
  bit rows and distances from the codes instead of hard-coded strings.
- Alt texts and SVG descriptions note that the Semantic-Code example string
  comes from an experimental implementation, since ISO 24138:2024 reserves that
  unit without standardizing an algorithm.
- Structure figure: show each ISCC-UNIT as a white card whose top edge is a
  24 px band of the unit colour, with the name, unit string and essence in
  one text colour instead of switching between white and near-black on colour
  fields. Chosen with the brand agent over plate and chip variants.
@titusz
titusz merged commit ceb4247 into main Sep 21, 2026
3 checks passed
@titusz
titusz deleted the docs/brand-illustrations branch September 21, 2026 19:58
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