docs: standardise compact README badge layout - #23
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the agreed README presentation guidance to the scaffold skill: a compact group beneath the title, ordered CI, licence, Omarchy identity/category, then compatibility.
Explains consistent displayed height, preserved proportions, linked alt-labelled images and natural mobile wrapping. Includes a commit-pinned HTML identity/compatibility example. CI must reflect the actual workflow; version support requires a declared policy and links to project-local compatibility notes. The generated baseline does not acquire an invented support claim.
Also fixes the general badge row's escaped table delimiter in the topic mapping. The canonical skill and reference are synced into the OpenAI adapter.
Validation: all 55 local tests and repository checks pass, skill validation passes, and git diff --check passes. Documentation only; existing SVG artwork and release metadata are unchanged.
Dogfooding in this repository
The bundle README now uses the same compact row: live main-branch CI, MIT licence, Built for Omarchy | Plugin, and Omarchy | 4.0.0+. The compatibility badge links to the toolkit's maintained scope and testing limitations. All four images display at 20 px; the guidance reflects GitHub's actual rendering of mixed native-size badges.
Rendered GitHub README
Captured from this PR's branch on GitHub.
The version badge now includes the official Omarchy icon, matching the identity badge; the screenshot shows the updated artwork.
Requested version label:
4.0.0+, with matching open-ended support notes and pinned artwork.