[PR #69] [MERGED] docs: put the README on the universal-modder brand #99

New issue

Closed

opened 2026-10-15 20:53:23 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-15 20:53:23 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/rehan-remade/universal-modder/pull/69
Author: @rehan-remade
Created: 10/5/2026
Status: ✅ Merged
Merged: 10/5/2026
Merged by: @rehan-remade

Base: main ← Head: docs/brand-readme

📝 Commits (1)

b03939b docs: put the README on the universal-modder brand

📊 Changes

35 files changed (+87 additions, -37 deletions)

View changed files

📝 .codex-plugin/plugin.json (+1 -1)
📝 README.md (+64 -36)
➕ docs/media/badges/agents.png (+0 -0)
➕ docs/media/badges/fal.png (+0 -0)
➕ docs/media/badges/knowledge.png (+0 -0)
➕ docs/media/badges/license.png (+0 -0)
📝 docs/media/banner.png (+0 -0)
➕ docs/media/icons/backup-dark.svg (+1 -0)
➕ docs/media/icons/backup-light.svg (+1 -0)
➕ docs/media/icons/comfy-dark.svg (+1 -0)
➕ docs/media/icons/comfy-light.svg (+1 -0)
➕ docs/media/icons/fal-dark.svg (+1 -0)
➕ docs/media/icons/fal-light.svg (+1 -0)
➕ docs/media/icons/kb-dark.svg (+1 -0)
➕ docs/media/icons/kb-light.svg (+1 -0)
➕ docs/media/icons/publish-dark.svg (+1 -0)
➕ docs/media/icons/publish-light.svg (+1 -0)
➕ docs/media/icons/render3d-dark.svg (+1 -0)
➕ docs/media/icons/render3d-light.svg (+1 -0)
➕ docs/media/icons/scan-dark.svg (+1 -0)

...and 15 more files

📄 Description

Puts the README on the universal-modder brand: void and coal grounds, Geist Pixel and Sometype Mono, magenta used only for small accents.

See the README rendered on this branch

What changed

Banner: "mod any game." with six recent mods (Minecraft × GTA V, the Nether, Halo × Minecraft, World at War × Minecraft). It also mentions the coming mod hub.
Teaser GIF: the same six mods, 1.7 s each, each with a label. 5.6 MB, up from 2.5 MB, because it has six clips.
Badges: Sometype Mono on coal, replacing the lime shields.io badges.
CLI table: a pixel icon for each um command, with light and dark versions. The kit had no icon for um comfy, so this adds one on the same 12 × 12 grid.
Pipeline image: redrawn on the brand's coal panels, with Geist Pixel headings.
New copy: a mod hub line, a Halo prompt in Try it, four community field notes, and a Made a mod with it? section with a badge for mod pages.
Install: two-step installs now put each command on its own line.
Brand assets: logo.png, logo-128.png and both wordmarks now use the new brand, at the same sizes. The Codex brandColor is now #FF3CD2 to match.

Why the Skills and CLI tables are HTML

GitHub gives every image max-width: 100%. Inside an auto-width table, Chrome lets such an image shrink to almost nothing, so the 36 px icons drew at 13 px. Skill names also broke at their hyphens. A width on the header cells (GitHub keeps it) holds each column open. A few no-break spaces in the empty icon header keep the icons at 36 px on phones too. Each skill name now links to its folder.

Checks

Rendered through GitHub's markdown API and screenshotted in light and dark at 830 px (GitHub's README width) and at 390 px. Both themes load every image. The dark <source> is picked the way github.com's themed-picture does it.
uv run --with pytest pytest -q tests: 57 passed
um kb check --index: 45 notes pass
um publish check .: 0 failures. Its one warning is an absolute path in an existing Project Zomboid note, which this PR doesn't touch.

🤖 Generated with Claude Code

_{🔄 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/rehan-remade/universal-modder/pull/69 **Author:** [@rehan-remade](https://github.com/rehan-remade) **Created:** 10/5/2026 **Status:** ✅ Merged **Merged:** 10/5/2026 **Merged by:** [@rehan-remade](https://github.com/rehan-remade) **Base:** `main` ← **Head:** `docs/brand-readme` --- ### 📝 Commits (1) - [`b03939b`](https://github.com/rehan-remade/universal-modder/commit/b03939b849b1f38adc23ae96f48e130b2b737ca3) docs: put the README on the universal-modder brand ### 📊 Changes **35 files changed** (+87 additions, -37 deletions) <details> <summary>View changed files</summary> 📝 `.codex-plugin/plugin.json` (+1 -1) 📝 `README.md` (+64 -36) ➕ `docs/media/badges/agents.png` (+0 -0) ➕ `docs/media/badges/fal.png` (+0 -0) ➕ `docs/media/badges/knowledge.png` (+0 -0) ➕ `docs/media/badges/license.png` (+0 -0) 📝 `docs/media/banner.png` (+0 -0) ➕ `docs/media/icons/backup-dark.svg` (+1 -0) ➕ `docs/media/icons/backup-light.svg` (+1 -0) ➕ `docs/media/icons/comfy-dark.svg` (+1 -0) ➕ `docs/media/icons/comfy-light.svg` (+1 -0) ➕ `docs/media/icons/fal-dark.svg` (+1 -0) ➕ `docs/media/icons/fal-light.svg` (+1 -0) ➕ `docs/media/icons/kb-dark.svg` (+1 -0) ➕ `docs/media/icons/kb-light.svg` (+1 -0) ➕ `docs/media/icons/publish-dark.svg` (+1 -0) ➕ `docs/media/icons/publish-light.svg` (+1 -0) ➕ `docs/media/icons/render3d-dark.svg` (+1 -0) ➕ `docs/media/icons/render3d-light.svg` (+1 -0) ➕ `docs/media/icons/scan-dark.svg` (+1 -0) _...and 15 more files_ </details> ### 📄 Description Puts the README on the universal-modder brand: void and coal grounds, Geist Pixel and Sometype Mono, magenta used only for small accents. ![The new README banner](https://github.com/rehan-remade/universal-modder/blob/docs/brand-readme/docs/media/banner.png?raw=true) [See the README rendered on this branch](https://github.com/rehan-remade/universal-modder/blob/docs/brand-readme/README.md) ## What changed - **Banner:** "mod any game." with six recent mods (Minecraft × GTA V, the Nether, Halo × Minecraft, World at War × Minecraft). It also mentions the coming mod hub. - **Teaser GIF:** the same six mods, 1.7 s each, each with a label. 5.6 MB, up from 2.5 MB, because it has six clips. - **Badges:** Sometype Mono on coal, replacing the lime shields.io badges. - **CLI table:** a pixel icon for each `um` command, with light and dark versions. The kit had no icon for `um comfy`, so this adds one on the same 12 × 12 grid. - **Pipeline image:** redrawn on the brand's coal panels, with Geist Pixel headings. - **New copy:** a mod hub line, a Halo prompt in *Try it*, four community field notes, and a *Made a mod with it?* section with a badge for mod pages. - **Install:** two-step installs now put each command on its own line. - **Brand assets:** `logo.png`, `logo-128.png` and both wordmarks now use the new brand, at the same sizes. The Codex `brandColor` is now `#FF3CD2` to match. ## Why the Skills and CLI tables are HTML GitHub gives every image `max-width: 100%`. Inside an auto-width table, Chrome lets such an image shrink to almost nothing, so the 36 px icons drew at 13 px. Skill names also broke at their hyphens. A `width` on the header cells (GitHub keeps it) holds each column open. A few no-break spaces in the empty icon header keep the icons at 36 px on phones too. Each skill name now links to its folder. ## Checks - Rendered through GitHub's markdown API and screenshotted in light and dark at 830 px (GitHub's README width) and at 390 px. Both themes load every image. The dark `<source>` is picked the way github.com's `themed-picture` does it. - `uv run --with pytest pytest -q tests`: 57 passed - `um kb check --index`: 45 notes pass - `um publish check .`: 0 failures. Its one warning is an absolute path in an existing Project Zomboid note, which this PR doesn't touch. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-15 20:53:23 +00:00