Skip to content

docs: add Examples showcase to README with swatch-grid preview#16

Merged
TMHSDigital merged 1 commit into
mainfrom
docs/examples-showcase
Jun 20, 2026
Merged

docs: add Examples showcase to README with swatch-grid preview#16
TMHSDigital merged 1 commit into
mainfrom
docs/examples-showcase

Conversation

@TMHSDigital

Copy link
Copy Markdown
Owner

Stage 3 of 3 — README screenshots + gallery placement

Adds an Examples showcase section to the root README, seeded with the swatch-grid example.

  • Committed preview: examples/swatch-grid/preview.webp — optimized WebP, 1200×450, ~6 KB (well under the 150 KB target), downscaled from the Stage-2 HDRI hero render (the genuinely-better variant). Referenced with a relative markdown/HTML link and descriptive alt text; .gitignore does not exclude it.
  • Section: an HTML table matching the README's centered style, structured to hold multiple examples later (one row now): preview image + name linking to examples/swatch-grid/ + one line on what it demonstrates.
  • Counts unchanged (12 skills … 17 snippets); this is docs:-only.

Gallery / Pages

Investigated: no Pages site, docs/ dir, gh-pages branch, or Pages config exists. Per the brief I did not stand one up. The full-res hero renders (hero_5.1.png / hero_4.5.png, 1920×720) remain in scratch; "gallery/Pages setup" is flagged as a separate decision.

Release-gate check (the point of merging this normally)

docs:-only → under the new gate it must not cut a release. Merging via a normal squash (no [skip ci]) to confirm the gate's SKIP path on a real push event (earlier sessions only proved SKIP via workflow_dispatch because Actions was dropping push/PR events). Post-merge I'll confirm the push-triggered release.yml fired, printed SKIP, and cut no release (VERSION stays 0.3.0) — or state plainly if the push event didn't fire.

🤖 Generated with Claude Code

Adds an Examples section (a table built to hold multiple examples) seeded with swatch-grid: an optimized WebP preview (1200x450, ~6 KB, sourced from the Stage-2 HDRI hero render), relative-linked with descriptive alt text, plus the example name linking to examples/swatch-grid/ and one line on what it demonstrates. README content-count line unchanged. No Pages/gallery exists in this repo, so none was created (flagged as a separate decision).

Signed-off-by: fOuttaMyPaint <TMhospitalitystrategies@gmail.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 20, 2026
@TMHSDigital TMHSDigital merged commit d27a4ef into main Jun 20, 2026
8 checks passed
@TMHSDigital TMHSDigital deleted the docs/examples-showcase branch June 20, 2026 02:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant