Skip to content

feat(assets): new mark, restructured README, docs palette#1566

Merged
danielcopper merged 1 commit into
mainfrom
feature/mark-and-readme
Jul 22, 2026
Merged

feat(assets): new mark, restructured README, docs palette#1566
danielcopper merged 1 commit into
mainfrom
feature/mark-and-readme

Conversation

@danielcopper

Copy link
Copy Markdown
Owner

Everything from #1546 except the rename. The name stays decky-romm-sync so this can land while the new one is still being decided.

The mark

The right-hand half of a Steam Deck set in a disc, split along a 45° facet that runs unbroken across disc, body, screen and every control. It replaces the old banner, which was AI-generated and carried a garbled wordmark.

Positions and sizes sit on a millimetre grid mapped into drawing units by one constant, so the layout is adjusted by changing a measurement rather than nudging coordinates. scripts/logo/gen.py renders both the shipped asset and a contact sheet of the alternatives.

README

Rebuilt around the mark: mark, name, tagline, two rows of guide links, then one row of user-facing badges. The six CI and quality badges move down to Contributing, where they address the audience that reads them. A RomM ≥ 4.9.0 badge is new — that is the most common support question, and it now answers itself. The release badge reads package.json instead of the tag, because the tags carry the project name. Both install routes collapse into details blocks.

Feature list

Corrected against the code. Three claims were wrong rather than merely vague:

  • Save sync was described as "newest-wins conflict resolution with a manual override". There is no newest-wins. The decision is hash-based: it resolves automatically only where that is provably lossless, and any genuine two-sided divergence blocks until you choose. Getting this backwards is worse than saying nothing, because it is a claim about whether saves can be silently overwritten.
  • Steam Input was described as per-shortcut. There is one global mode, applied in bulk.
  • RetroDECK path migration read as though the plugin moves your install. It notices that you moved it, then relocates the ROMs, BIOS files and saves it manages.

Artwork was misattributed — only the cover comes from RomM, the rest needs a SteamGridDB key. Collections, save slots and version history, RetroAchievements, multi-disc, region switching, core selection and the cleanup tools were missing entirely. "Controller friendly" is dropped as table stakes for a plugin that renders in the gamepad UI.

Docs site

Off deep purple, which sat in RomM's colour family, onto the mark's palette — custom colours in both schemes, since Material has no named palette in this range. The mark becomes the site logo and favicon.

Note for review

markdownlint's MD033 is narrowed to an allow-list of the elements the header needs rather than switched off, so stray HTML elsewhere is still caught.

The wordmark is deliberately absent: it would have to spell a name, and that is still open. gen.py can compose the lockup as soon as there is one — it loads the outlines on demand.

Supersedes #1546 if the rename takes longer than expected; otherwise #1546 rebases onto this.

docs: the documentation site's palette, logo and favicon are updated in this change.

Replaces the old banner, which was AI-generated and carried a garbled wordmark,
with a drawn mark: the right-hand half of a Steam Deck set in a disc, split
along a 45 degree facet that runs unbroken across disc, body, screen and every
control. Its geometry is derived rather than eyeballed -- positions and sizes
sit on a millimetre grid mapped into drawing units by one constant, so a
position is corrected by changing a number that means something physical.
scripts/logo/gen.py renders both the shipped asset and a contact sheet of the
alternatives that were considered.

The README is rebuilt around it: mark, name, tagline, two rows of guide links,
then one row of user-facing badges. The six CI and quality badges move down to
Contributing, where they say something to the audience that reads them; a
RomM >= 4.9.0 badge is new, since that is the most common support question. The
release badge reads package.json rather than the tag, because the tags carry the
project name. Both install routes collapse into details blocks.

The feature list is corrected against the code. Three claims were wrong rather
than merely vague. Save sync was described as "newest-wins conflict resolution";
there is no newest-wins -- the decision is hash-based, resolves automatically
only where that is provably lossless, and blocks on any genuine two-sided
divergence. Getting that backwards matters, because it is a claim about whether
saves can be silently overwritten. Steam Input was described as per-shortcut; it
is one global mode applied in bulk. RetroDECK path migration read as though the
plugin moves your install; it notices that you moved it and relocates what it
manages. Artwork was misattributed -- only the cover comes from RomM, the rest
needs a SteamGridDB key -- and collections, save slots, RetroAchievements,
multi-disc, region switching, core selection and the cleanup tools were missing
entirely.

The documentation site moves off deep purple onto the mark's palette, set as
custom colours in both schemes since Material has no named palette in this
range, and takes the mark as its logo and favicon.

markdownlint's MD033 is narrowed to an allow-list of the elements the header
needs rather than switched off, so stray HTML elsewhere is still caught.

The project name is untouched.
@github-actions github-actions Bot added the area:ci CI, tooling, SonarCloud label Jul 22, 2026
@danielcopper
danielcopper enabled auto-merge (squash) July 22, 2026 20:18
@sonarqubecloud

Copy link
Copy Markdown

@danielcopper
danielcopper merged commit 6d17f8c into main Jul 22, 2026
18 checks passed
@danielcopper
danielcopper deleted the feature/mark-and-readme branch July 22, 2026 20:21
danielcopper added a commit that referenced this pull request Jul 22, 2026
…er (#1567)

Two small fixes to the header that #1566 introduced.

**The badge row wrapped.** Six badges in the `for-the-badge` style are
wider than a typical readme column, so the last one stranded on a second
line, which reads as an accident rather than a layout. The **licence
badge** is removed: GitHub already shows the licence as a tab directly
above the readme, so it was the one badge carrying nothing the reader
did not already have. Five remain and fit.

**The tagline had a rule under it.** GitHub draws one under `h1` and
`h2`, which put a line between the tagline and the guide links for no
reason. It becomes an `h3` element, which keeps the size without the
rule; `markdownlint`'s allow-list gains `h3`.

docs: N/A — the readme is the change; no documentation page describes
it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:ci CI, tooling, SonarCloud

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant