docs: align README with Aviendha/Aludra family branding - #106
Merged
Conversation
- Swap banner image for centered logo + badge row above the title - Add Lineage note cross-linking Aviendha, Nynaeve, Ixian, and Aludra - List WooCommerce and Aludra as optional/recommended in Requirements - Add a License section pointing to LICENSE.md (GPL v3) - Remove now-orphaned assets/images/readme-banner.jpg
Documents the README family-branding changes in CHANGELOG.md and readme.txt, and bumps style.css to match.
Packagist reads this field for the README's shields.io License badge. style.css, readme.txt, and LICENSE.md were already migrated to GPL v3; composer.json was missed at the time.
Use the same description already published on the GitHub repo instead of the generic 'A WordPress block theme by Jasper Frumau' placeholder.
Verified against actual file counts: 119 non-WooCommerce + 24 WooCommerce patterns (143 total) in patterns/, 19 files in templates/. - README.md's '125+ patterns' (quoted apart from '24 WooCommerce patterns') overclaimed the real 119 non-WooCommerce count -> 115+ - readme.txt's three '125+' mentions quote a combined total and undersold the real 143 -> 140+ - readme.txt's '17 page and post templates' undercounted the real 19 and omitted WooCommerce templates -> matches README.md's wording
…s everywhere Recounted every pattern's Categories: header (vertical tag takes priority over a generic one) to replace the stale per-category breakdown in CONTRIBUTING.md and readme.txt's Pattern Collection section. New verified totals (143 patterns): Core 40, Specialized 25 (Pages 16, up from a stale 11), Industry Verticals 54 (Spa 14 and Food & Beverage 17, both up from stale figures; Legal/Home Improvement/Nail Salon were already accurate), WooCommerce 24. Statistics and Team dropped from Core Patterns — every pattern still tagged with those categories is vertical-specific now. Also surfaces the ready-to-insert page patterns (full-page compositions like Homepage, About, Contact, Services, and the Store variants) as a named capability in style.css's Description, composer.json's description, README.md's Page Layouts bullet, and readme.txt's intro/Key Features/Pattern Collection — previously only implicit in the overall pattern count. README.md's bullet also now lists all 8 page patterns instead of the original 4, which omitted the Store-specific compositions.
keywords had lowercase 'wordpress', tripping the required rule -> 'WordPress'. Also caught while in there: version was stale at 4.9.0 and license still GPL-2.0-or-later (same issue already fixed in composer.json); both corrected, and description's pattern count refreshed to match.
CHANGELOG.md and readme.txt both described the package.json bug by quoting the lowercase string verbatim, which trips the same WordPress_Spelling_Check rule the previous commit was fixing. Rephrased to describe the bug without spelling it out.
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.
Summary
Brings README.md in line with the badge/logo/lineage conventions already used by Aviendha and Aludra's READMEs, then fixes several license/description/count inaccuracies discovered along the way. Bumped to 4.9.1 (patch, docs-only).
README branding
assets/images/readme-banner.jpg, now unreferencedLicense & description fixes
composer.json's andpackage.json'slicensefields still saidGPL-2.0-or-later— missed when style.css/readme.txt/LICENSE.md were migrated to GPL v3.composer.json's is what Packagist reads for the README's shields.io License badge.composer.json'sdescriptionwas the placeholder"A WordPress block theme by Jasper Frumau"— replaced with the theme's actual GitHub repo description.package.json'sversionwas stale at4.9.0; itskeywordsarray had lowercase"wordpress", which trips the Theme Check GitHub Action's requiredWordPress_Spelling_Checkrule — this is what was failing CI.Pattern/template count corrections
Verified against the actual files: 119 non-WooCommerce + 24 WooCommerce patterns (143 total) in
patterns/, 19 files intemplates/.Categories:header. Notable moves: Pages 11→16, Spa & Wellness 10→14, Food & Beverage 14→17; Statistics/Team dropped from Core (every remaining tagged pattern is vertical-specific now)Page patterns messaging
Surfaced the 8 ready-to-insert page patterns (full-page compositions: Homepage, About, Contact, Services, plus Store variants) as a named capability in style.css's Description, composer.json's/package.json's description, README.md's Page Layouts bullet, and readme.txt — previously only implicit in the pattern count. README.md's bullet also now lists all 8 instead of the original 4 (it omitted the Store-specific compositions).