Skip to content

docs(readme): redraw the header, add a viewer tour in both themes, the agent loop and a card's parts, and link the website - #35

Merged
hyamero merged 2 commits into
mainfrom
docs/readme-images
Oct 2, 2026
Merged

hyamero merged 2 commits into
mainfrom
docs/readme-images

Conversation

@hyamero

@hyamero hyamero commented Oct 1, 2026 •

Copy link
Copy Markdown
Member

Reworks the README's images. Each one is a light and dark pair in a <picture>, so GitHub shows the one that matches the reader's theme. The README also gets links to the website.

  • Header: the tagline "Every layer of your stack, on one map." and the one-line description, with the Commerce API diagram drawn by stackmap (its checkout route lit) in place of the enlarged mark. It's a 2× PNG pair (2560×800, palette, about 75 KB each), so the old header SVGs are removed and assets/brand/README.md lists the new files.
  • Viewer tour, in The viewer: it replaces the two half-width screenshots, which were too small to read and predated route, play and present. It's recorded frame by frame from the current viewer on the Commerce API demo: zoom in and select Orders DB (connections and evidence), open the Checkout path view, route Storefront → Stripe, and play the flow. 13.5 s at 1656×1035, as a lossless animated WebP (2.3 MB light, 2.1 MB dark), because lossy encodes left ghost text from earlier frames. tour.webp keeps its path as the light version, with tour-dark.webp beside it.
  • Agent loop, in Quick start after the prompt: an animated SVG (CSS animation only, fonts embedded). Under raw.githubusercontent.com's CSP (default-src 'none'; style-src 'unsafe-inline'; sandbox) it renders and plays in Chromium, Firefox and WebKit.
  • A card's parts and the six connection styles, in The diagram: a 2× palette PNG, about 61 KB.
  • A Website · Docs · Examples row under the header, and the website's schema reference beside the skill's.

The npm README is generated from this one at pack time, with image paths pointed at main, so it picks these changes up.

@vercel

vercel Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
stackmap-site Ignored Ignored Preview Oct 2, 2026 3:56am UTC

…wer in both themes, and drop the kinds and CLI images
@hyamero hyamero changed the title docs(readme): add images of the agent loop, the five kinds, a card and the CLI, and link the website docs(readme): redraw the header, add a viewer tour in both themes, the agent loop and a card's parts, and link the website Oct 2, 2026
@hyamero
hyamero merged commit 5986095 into main Oct 2, 2026
7 checks passed
@hyamero
hyamero deleted the docs/readme-images branch October 2, 2026 04:18
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.1.0-rc.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant