Skip to content

docs: add a screenshot banner to the README - #6

Merged
kalwalt merged 1 commit into
devfrom
docs/readme-banner
Oct 15, 2026
Merged

kalwalt merged 1 commit into
devfrom
docs/readme-banner

Conversation

@kalwalt

@kalwalt kalwalt commented Oct 15, 2026

Copy link
Copy Markdown
Member

Summary

Adds a screenshot banner to the README, and fixes the demo graph layouts that the screenshot exposed.

Banner

  • docs/images/webarkit-studio.webp: the multi NFT demo open in the studio, with the live preview tracking both markers (pinball → torus knot, kuva → box).
  • 4:3, 1600×1200, captured at 2× device scale and downscaled, so node labels stay readable. WebP (≈160 kB) keeps the repository history light.
  • Shown under the badges, centred, 800 px wide, with descriptive alt text.

Demo graph layout

Since near / far were added, Controller Settings is taller and overlapped One Euro Filter. The two Light nodes also overlapped Scene. All three demos (pinball-three, pinball-babylon, multi-three) are now laid out on four columns, spaced by the real node heights measured while tracking (Inspector and Stats grow at runtime).

Only position.x / position.y change; nodes, params and edges are untouched, so there is no graph format change.

Other

  • .gitattributes: add the missing final newline.
  • CHANGELOG.md: "Fixed" entry for the overlapping demo nodes.

Test plan

  • npm run typecheck
  • npm test: 44 passed
  • npm run test:e2e: 11 passed. In one run "an init error is shown on the failing node" failed once; with --repeat-each 5 it passed every time, so it looks flaky rather than caused by the layout change.
  • Check the README rendering on GitHub (light and dark theme)

🤖 Generated with Claude Code

https://claude.ai/code/session_01LeYTpqS6Pp22dNxwQ1gjWF

- docs/images/webarkit-studio.webp: the multi NFT demo in the studio,
  4:3 (1600x1200), with the live preview tracking pinball and kuva.
- Re-layout the demo graphs: Controller Settings grew with near / far
  and overlapped One Euro Filter; nodes are now spaced by their size.
- .gitattributes: add the missing final newline.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LeYTpqS6Pp22dNxwQ1gjWF
@kalwalt kalwalt self-assigned this Oct 15, 2026
@kalwalt kalwalt added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 15, 2026
@kalwalt
kalwalt changed the base branch from master to dev October 15, 2026 20:59
@kalwalt
kalwalt merged commit 4a666f0 into dev Oct 15, 2026
2 checks passed
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants