morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #6915] [MERGED] docs(readme): show a dark showcase image on dark themes #7446

New issue

Closed

opened 2026-11-01 21:47:55 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-11-01 21:47:55 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/6915
Author: @CassieFox23
Created: 10/23/2026
Status: ✅ Merged
Merged: 10/23/2026
Merged by: @morluto

Base: main ← Head: docs/readme-showcase-dark-mode

📝 Commits (1)

52331b8 docs(readme): show a dark showcase image on dark themes

📊 Changes

26 files changed (+376 additions, -22 deletions)

View changed files

📝 README.md (+6 -1)
➕ docs/assets/rea-showcases-dark.svg (+118 -0)
➖ docs/assets/rea-showcases.png (+0 -0)
➕ docs/assets/rea-showcases.svg (+118 -0)
📝 docs/readme/README_ar.md (+6 -1)
📝 docs/readme/README_de.md (+6 -1)
📝 docs/readme/README_el.md (+6 -1)
📝 docs/readme/README_es.md (+6 -1)
📝 docs/readme/README_fa.md (+6 -1)
📝 docs/readme/README_fr.md (+6 -1)
📝 docs/readme/README_id.md (+6 -1)
📝 docs/readme/README_it.md (+6 -1)
📝 docs/readme/README_ja.md (+6 -1)
📝 docs/readme/README_ko.md (+6 -1)
📝 docs/readme/README_ml.md (+6 -1)
📝 docs/readme/README_pl.md (+6 -1)
📝 docs/readme/README_pt-BR.md (+6 -1)
📝 docs/readme/README_ru.md (+6 -1)
📝 docs/readme/README_th.md (+6 -1)
📝 docs/readme/README_tr.md (+6 -1)

...and 6 more files

📄 Description

TL;DR: The README showcase picture now has a dark version for dark themes. GitHub's page picks up both images. Nobody has looked at it on a screen yet. The light picture is a redraw, so it differs a little from the old PNG.

Summary

The README showcase image was one light PNG. It showed the DX-Ball, Notion and TH04 illustrations. On a dark theme it stays a pale slab. This adds docs/assets/rea-showcases.svg (light) and docs/assets/rea-showcases-dark.svg (dark). It deletes docs/assets/rea-showcases.png. It swaps the linked image in README.md and all 21 files in docs/readme/. The new markup is a <picture> with a prefers-color-scheme: dark source. Alt text and link targets are unchanged.
Related issue: none linked. The contributing guide says a doc change like this needs no okay in advance. So I opened this without one.

Problem and expected behavior

Not a bug fix. Observable outcome: on a dark GitHub theme the showcase image is dark. On a light theme it is the light SVG.
The light image is a redraw, not a copy, because an SVG cannot equal a PNG. The PNG is 960 x 263 with soft shadows and noise, so the redraw uses clean shapes. I compared the redraw with the PNG at the same size, using CairoSVG 2.9.1. The mean absolute error is 3.22 of 255 per channel. 18,183 pixels (7.2%) have a summed RGB difference above 24. 9,403 have one above 60. The weak spots come from my earlier job's look at 3x crops. The PNG's ring dots and frame edges are stair-stepped. The redraw is round there. The PNG has a faint halo. The redraw leaves it out.

Change and scope

Each README replaces [![ALT](path/rea-showcases.png)](HREF) with

<a href="HREF">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="path/rea-showcases-dark.svg" />
    <img alt="ALT" src="path/rea-showcases.svg" />
  </picture>
</a>

The path is docs/assets/... in README.md. It is ../assets/... in the 21 translations. The shape follows the star-history block already in README.md. website/figures.md gains a short "README showcases" section that says the two files must stay the same shape.
The PNG is deleted because nothing else references it (git grep rea-showcases.png on the branch finds nothing, exit 1). Say a maintainer wants the PNG as the light image. Then the fix is to drop the light SVG. Point each <img src> back at the PNG. The dark SVG stays.
Not included: a dark PNG with the original geometry. An earlier job made one by recolouring the PNG's palette; it keeps the stair-steps but adds a binary file. I chose editable SVG.
Not included: the link preview card and favicon. Those landed in #6909. This branch is rebased on it, and website/figures.md keeps both paragraphs.

Follow the contribution scope.
Unresolved scope, authority, side effects, or required verification block
integration. Link the required maintainer scope decision for new providers or
capabilities involving target execution, injection, mutation, or protection
recovery; ordinary fixes within existing boundaries may state "not applicable".
Draft PRs may leave the scope decision pending and the readiness and merge checklists
unchecked. Maintainers can help resolve open questions.

Contract and boundary impact

Semantic owner and earliest changed stage:
README.md and docs/readme/README_*.md, the image markup; plus two new assets in docs/assets/. No code path changes.
Contribution scope fit and linked maintainer decision:
Not applicable. This is documentation. It sits inside the existing README boundary. It admits nothing new. The contributing guide says a doc change like this needs no okay in advance.
CLI and MCP/tool-catalog contract:
None. No CLI command, MCP tool or catalog entry is touched.
Provider, bridge, target-format, or platform compatibility:
Not applicable to providers. GitHub wraps the picture in themed-picture. It is unverified whether GitHub switches the <picture> source from the OS setting or from its own theme setting.
Evidence, artifact, provenance, or reconstruction contract:
None.
Target selection, authority, upstream behavior, and cleanup details (if applicable):
Not applicable. Nothing is launched or extracted.
Generated metadata (docs/public/product-catalog.json), package, or installation impact (CI generates and validates ignored catalogs and skills/; edit authored instructions in .agents/skills/reverse-engineer-anything/ and never commit build outputs):
None. No docs/public/product-catalog.json, package or skill file is touched. npm run docs:check passes (exit 0).

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

Read existing files or captured data.
Launch or attach to a process.
Inject instrumentation or run scripts/code.
Change process memory, registers, files, or configuration.
Contact network services.
Recover protected code or work around protections.
Documentation or usability only; no target interaction.
Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

Tests added or updated:
None added. The README checks that exist already cover the 22 files: tests/conformance/readmeConsistency.test.ts ran in npm run docs:check (9 passed). It is the job of scripts/lib/docs-facts.mjs to compare link targets across translations. It reads ](...), src= and href=. An earlier job read its regex as not covering srcset=. I did not re-read it.
Base reproduction or other evidence:
Executed this job, on the committed branch. git grep -c rea-showcases-dark.svg over README.md and docs/readme finds it in 22 files, and git grep rea-showcases.png finds nothing. I measured the redraw-versus-PNG numbers in the section above this job. The PNG is from upstream/main f71308713. The SVG is from this branch. The size is the same, 960 x 263. The renderer is CairoSVG 2.9.1. Contrast figures for the dark SVG are from an earlier job. I did not recompute them. Two examples are 12.14:1 for the outline and 8.34:1 for the ring dots. Some dark fills sit under 3:1 against the panel. They rely on their outlines.
User-visible CLI/MCP output (if applicable):
Not applicable.
Remaining proof gaps:
- Not seen: no browser and no GitHub render. I did not see either image on a screen.
- GitHub render, checked on my fork's branch page. GitHub rewrites the relative srcset to the same raw path as the img src. It also wraps the picture in its themed-picture. Both SVGs load (HTTP 200, image/svg+xml). I read the page HTML; nobody has looked at it on a screen.
- I found two precedents. They are the star-history block here and GitHub's own changelog example. Both use absolute srcset URLs. This PR uses relative ones. The check on my fork found that GitHub rewrites a relative srcset, so no absolute-URL fallback is needed.
- The light image is a redraw and changes a little (numbers above). A second reviewer should open both SVGs before anyone calls the redraw faithful.
- The pre-push hook ran npm run check:fast (typecheck and lint). Both passed, from turbo's cache. npm run check:pr, the full test suite and knip were not run.

For evidence-bearing changes:

Observed, derived, and inferred claims remain distinguishable.
Artifact identity, source provenance, and failed attempts remain preserved.
Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

npm ci --ignore-scripts, Node 24.22.1 — exit 0
npm run docs:check, Node 24.22.1 — exit 0, 6 turbo tasks successful, 9 tests passed in tests/conformance/readmeConsistency.test.ts
python3 scripts/website.py check — exit 0. It includes scripts/test-website.py. It ran on Python 3.14.7 with CairoSVG 2.9.1 and polib 1.2.0. It ends with "Checked shared HTML (0 pages changed)."
npx oxfmt --check README.md docs/readme website/figures.md docs/assets — exit 0, 23 files matched
I ran the redraw-versus-PNG test and a git grep check, as in the evidence section. Exit 0 and 1.
No check failed, so no comparison against plain upstream/main was needed.

Compatibility, safety, and release

Breaking changes or migration steps:
None. The image URL changes and the PNG file is gone. Anyone who linked docs/assets/rea-showcases.png directly from outside the repo would get a 404. I found no such link in tracked files (git grep, exit 1). Outside links are unknown.
Real Hopper/Ghidra, browser, or OS coverage:
Not applicable. Nobody has run a browser on this or looked at it on a screen. I read GitHub's page HTML on my fork's branch page. Linux x64 only for the renders.
Package or release metadata impact:
None.
Security, privacy, process, or containment review:
None needed. Two static SVGs, one deletion and Markdown edits. No scripts, no network, no new dependency.

Author readiness

Human owner:

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

Before merge

This PR addresses a concrete problem or an agreed enhancement.
Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
The PR has one focused outcome and the title follows type(scope): outcome.
Related issue is linked, or the reason for not linking one is stated above.
Tests cover changed observable behavior and meaningful failure paths.
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output.
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

Test setup

Box: Nobara 44 (Fedora 44 base), Linux 7.2.11
CPU: AMD Ryzen 9 5900X, 12 cores / 24 threads
RAM: 31 GiB as free -g reports it
Node: 24.22.1 (npm 11.19.1)
Other: Python 3.14.7 in a venv with CairoSVG 2.9.1 and polib 1.2.0, the versions in website/requirements.txt
Head / base: 52331b80f / a2235b09a (rebased after #6909 merged; first tested at 3677a1011 on f71308713)

🤖 Written with Claude Code (Sonnet 5.5, verified by Opus 5.5), posted with my OK 🦊

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/6915 **Author:** [@CassieFox23](https://github.com/CassieFox23) **Created:** 10/23/2026 **Status:** ✅ Merged **Merged:** 10/23/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/readme-showcase-dark-mode` --- ### 📝 Commits (1) - [`52331b8`](https://github.com/morluto/rea/commit/52331b80f87faf65a08cbd8847155765d33d0e10) docs(readme): show a dark showcase image on dark themes ### 📊 Changes **26 files changed** (+376 additions, -22 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+6 -1) ➕ `docs/assets/rea-showcases-dark.svg` (+118 -0) ➖ `docs/assets/rea-showcases.png` (+0 -0) ➕ `docs/assets/rea-showcases.svg` (+118 -0) 📝 `docs/readme/README_ar.md` (+6 -1) 📝 `docs/readme/README_de.md` (+6 -1) 📝 `docs/readme/README_el.md` (+6 -1) 📝 `docs/readme/README_es.md` (+6 -1) 📝 `docs/readme/README_fa.md` (+6 -1) 📝 `docs/readme/README_fr.md` (+6 -1) 📝 `docs/readme/README_id.md` (+6 -1) 📝 `docs/readme/README_it.md` (+6 -1) 📝 `docs/readme/README_ja.md` (+6 -1) 📝 `docs/readme/README_ko.md` (+6 -1) 📝 `docs/readme/README_ml.md` (+6 -1) 📝 `docs/readme/README_pl.md` (+6 -1) 📝 `docs/readme/README_pt-BR.md` (+6 -1) 📝 `docs/readme/README_ru.md` (+6 -1) 📝 `docs/readme/README_th.md` (+6 -1) 📝 `docs/readme/README_tr.md` (+6 -1) _...and 6 more files_ </details> ### 📄 Description **TL;DR:** The README showcase picture now has a dark version for dark themes. GitHub's page picks up both images. Nobody has looked at it on a screen yet. The light picture is a redraw, so it differs a little from the old PNG.  ## Summary  The README showcase image was one light PNG. It showed the DX-Ball, Notion and TH04 illustrations. On a dark theme it stays a pale slab. This adds `docs/assets/rea-showcases.svg` (light) and `docs/assets/rea-showcases-dark.svg` (dark). It deletes `docs/assets/rea-showcases.png`. It swaps the linked image in README.md and all 21 files in `docs/readme/`. The new markup is a `<picture>` with a `prefers-color-scheme: dark` source. Alt text and link targets are unchanged. Related issue: none linked. The [contributing guide](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope) says a doc change like this needs no okay in advance. So I opened this without one. ## Problem and expected behavior  Not a bug fix. Observable outcome: on a dark GitHub theme the showcase image is dark. On a light theme it is the light SVG. The light image is a redraw, not a copy, because an SVG cannot equal a PNG. The PNG is 960 x 263 with soft shadows and noise, so the redraw uses clean shapes. I compared the redraw with the PNG at the same size, using CairoSVG 2.9.1. The mean absolute error is 3.22 of 255 per channel. 18,183 pixels (7.2%) have a summed RGB difference above 24. 9,403 have one above 60. The weak spots come from my earlier job's look at 3x crops. The PNG's ring dots and frame edges are stair-stepped. The redraw is round there. The PNG has a faint halo. The redraw leaves it out. ## Change and scope  Each README replaces `[![ALT](path/rea-showcases.png)](HREF)` with ```html <a href="HREF"> <picture> <source media="(prefers-color-scheme: dark)" srcset="path/rea-showcases-dark.svg" /> <img alt="ALT" src="path/rea-showcases.svg" /> </picture> </a> ``` The path is `docs/assets/...` in README.md. It is `../assets/...` in the 21 translations. The shape follows the star-history block already in README.md. `website/figures.md` gains a short "README showcases" section that says the two files must stay the same shape. The PNG is deleted because nothing else references it (`git grep rea-showcases.png` on the branch finds nothing, exit 1). Say a maintainer wants the PNG as the light image. Then the fix is to drop the light SVG. Point each `<img src>` back at the PNG. The dark SVG stays. Not included: a dark PNG with the original geometry. An earlier job made one by recolouring the PNG's palette; it keeps the stair-steps but adds a binary file. I chose editable SVG. Not included: the link preview card and favicon. Those landed in #6909. This branch is rebased on it, and `website/figures.md` keeps both paragraphs. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Unresolved scope, authority, side effects, or required verification block integration. Link the required maintainer scope decision for new providers or capabilities involving target execution, injection, mutation, or protection recovery; ordinary fixes within existing boundaries may state "not applicable". Draft PRs may leave the scope decision pending and the readiness and merge checklists unchecked. Maintainers can help resolve open questions. ## Contract and boundary impact  - Semantic owner and earliest changed stage: `README.md` and `docs/readme/README_*.md`, the image markup; plus two new assets in `docs/assets/`. No code path changes. - Contribution scope fit and linked maintainer decision: Not applicable. This is documentation. It sits inside the existing README boundary. It admits nothing new. The contributing guide says a doc change like this needs no okay in advance. - CLI and MCP/tool-catalog contract: None. No CLI command, MCP tool or catalog entry is touched. - Provider, bridge, target-format, or platform compatibility: Not applicable to providers. GitHub wraps the picture in `themed-picture`. It is unverified whether GitHub switches the `<picture>` source from the OS setting or from its own theme setting. - Evidence, artifact, provenance, or reconstruction contract: None. - Target selection, authority, upstream behavior, and cleanup details (if applicable): Not applicable. Nothing is launched or extracted. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact (CI generates and validates ignored catalogs and `skills/`; edit authored instructions in `.agents/skills/reverse-engineer-anything/` and never commit build outputs): None. No `docs/public/product-catalog.json`, package or skill file is touched. `npm run docs:check` passes (exit 0). Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage  - Tests added or updated: None added. The README checks that exist already cover the 22 files: `tests/conformance/readmeConsistency.test.ts` ran in `npm run docs:check` (9 passed). It is the job of `scripts/lib/docs-facts.mjs` to compare link targets across translations. It reads `](...)`, `src=` and `href=`. An earlier job read its regex as not covering `srcset=`. I did not re-read it. - Base reproduction or other evidence: Executed this job, on the committed branch. `git grep -c rea-showcases-dark.svg` over README.md and docs/readme finds it in 22 files, and `git grep rea-showcases.png` finds nothing. I measured the redraw-versus-PNG numbers in the section above this job. The PNG is from upstream/main f71308713. The SVG is from this branch. The size is the same, 960 x 263. The renderer is CairoSVG 2.9.1. Contrast figures for the dark SVG are from an earlier job. I did not recompute them. Two examples are 12.14:1 for the outline and 8.34:1 for the ring dots. Some dark fills sit under 3:1 against the panel. They rely on their outlines. - User-visible CLI/MCP output (if applicable): Not applicable. - Remaining proof gaps: - Not seen: no browser and no GitHub render. I did not see either image on a screen. - GitHub render, checked on my fork's branch page. GitHub rewrites the relative `srcset` to the same raw path as the `img src`. It also wraps the picture in its `themed-picture`. Both SVGs load (HTTP 200, `image/svg+xml`). I read the page HTML; nobody has looked at it on a screen. - I found two precedents. They are the star-history block here and GitHub's own changelog example. Both use absolute `srcset` URLs. This PR uses relative ones. The check on my fork found that GitHub rewrites a relative `srcset`, so no absolute-URL fallback is needed. - The light image is a redraw and changes a little (numbers above). A second reviewer should open both SVGs before anyone calls the redraw faithful. - The pre-push hook ran `npm run check:fast` (typecheck and lint). Both passed, from turbo's cache. `npm run check:pr`, the full test suite and knip were not run. For evidence-bearing changes: - [ ] Observed, derived, and inferred claims remain distinguishable. - [ ] Artifact identity, source provenance, and failed attempts remain preserved. - [ ] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed  - `npm ci --ignore-scripts`, Node 24.22.1 — exit 0 - `npm run docs:check`, Node 24.22.1 — exit 0, 6 turbo tasks successful, 9 tests passed in `tests/conformance/readmeConsistency.test.ts` - `python3 scripts/website.py check` — exit 0. It includes `scripts/test-website.py`. It ran on Python 3.14.7 with CairoSVG 2.9.1 and polib 1.2.0. It ends with "Checked shared HTML (0 pages changed)." - `npx oxfmt --check README.md docs/readme website/figures.md docs/assets` — exit 0, 23 files matched - I ran the redraw-versus-PNG test and a `git grep` check, as in the evidence section. Exit 0 and 1. - No check failed, so no comparison against plain upstream/main was needed. ## Compatibility, safety, and release  - Breaking changes or migration steps: None. The image URL changes and the PNG file is gone. Anyone who linked `docs/assets/rea-showcases.png` directly from outside the repo would get a 404. I found no such link in tracked files (`git grep`, exit 1). Outside links are unknown.  - Real Hopper/Ghidra, browser, or OS coverage: Not applicable. Nobody has run a browser on this or looked at it on a screen. I read GitHub's page HTML on my fork's branch page. Linux x64 only for the renders. - Package or release metadata impact: None. - Security, privacy, process, or containment review: None needed. Two static SVGs, one deletion and Markdown edits. No scripts, no network, no new dependency. ## Author readiness  Human owner: - [ ] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [ ] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [ ] I declare this PR ready for initial maintainer review. ## Before merge  - [ ] This PR addresses a concrete problem or an agreed enhancement. - [ ] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [ ] The PR has one focused outcome and the title follows `type(scope): outcome`. - [ ] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [ ] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [ ] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. <details> <summary>Test setup</summary> - Box: Nobara 44 (Fedora 44 base), Linux 7.2.11 - CPU: AMD Ryzen 9 5900X, 12 cores / 24 threads - RAM: 31 GiB as `free -g` reports it - Node: 24.22.1 (npm 11.19.1) - Other: Python 3.14.7 in a venv with CairoSVG 2.9.1 and polib 1.2.0, the versions in `website/requirements.txt` - Head / base: 52331b80f / a2235b09a (rebased after #6909 merged; first tested at 3677a1011 on f71308713) </details> 🤖 Written with Claude Code (Sonnet 5.5, verified by Opus 5.5), posted with my OK 🦊 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-11-01 21:47:55 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-11-05 01:48:02 +00:00

[PR #7446] fix(analysis-view): qualify 32-segment route limit in prefix-variance guidance #7841

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#7446

No description provided.

Rows
Columns