Skip to content

docs: launch README and new demo media - #9

Merged
sardi-dev merged 2 commits into
mainfrom
docs/launch
Oct 18, 2026
Merged

sardi-dev merged 2 commits into
mainfrom
docs/launch

Conversation

@sardi-dev

@sardi-dev sardi-dev commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

What and why

This prepares the public launch. The README explained what Wirehouse draws but not why it is worth using, and every picture still showed the 0.2.0 viewer.

docs(assets): new demo media of the 0.3.0 viewer, all from the live demo map.

  • demo.webp: 38 s hero animation (880 px, 12 fps, 5.6 MB, about the size of the old one):
    • a night-shift orbit
    • a downstream trace that ripples out from the backend
    • the "From a browser to PostgreSQL" route tour, walked stop by stop
    • the backend's app room
    • the day shift
    • the PostgreSQL schema diagram
    • the floor plan
  • demo.mp4: the same at 1280 x 720, 25 fps (8.4 MB), for the release page and social posts.
  • Nine screenshots (same file names, so existing links keep working) and the 1200 x 630 share card.
  • one-map-two-readers.png: the real wirehouse export output for the demo (Mermaid plus the connections table with file:line) beside the same map as a warehouse.

All of it was rendered frame by frame on a virtual clock (a page-level requestAnimationFrame/performance.now/setTimeout shim driven by Playwright), so motion is smooth even though the container has no GPU.

docs(readme): the README leads with the value.

  • Why Wirehouse: six points, each backed by what the code does (and by a test where one exists):
    • evidence per connection, commit-pinned, with Checks for anything dropped
    • current in seconds, with change review through --against
    • one offline file with no server or telemetry
    • answers real questions (trace, route, tour)
    • works with any agent or none
    • safe to share
  • How it compares: hand-drawn diagram vs. Mermaid in the docs vs. Wirehouse, on properties only (no claims about other products).
  • An eight-feature gallery with the new screenshots.
  • A "scanning a repository you did not write" bullet in Privacy and safety, covering the Pass 2 hardening.
  • Images and links are absolute, so the README also renders as the PyPI description. This fixes the PyPI item from TODO.md, which is removed there.

Note: image URLs point at main, so the new one-map-two-readers.png only shows in the rendered README after this merges.

How I checked it

  • python -m pytest passes (153)
  • Viewer changes: none. The media was recorded from docs/demo/index.html with no console errors, and I checked frames from each scene.
  • Every URL the README uses on main resolves to a file in this branch.
  • CHANGELOG.md updated under Unreleased

Ground rules

  • Nothing new is drawn or counted without a recorded connection or checked evidence (the media is the real demo page)
  • No secret values can reach archmap.json or the HTML
  • The page still loads nothing from the network

Every picture in the README still showed the 0.2.0 viewer. The demo
animation, MP4, nine screenshots and the share card are recorded again
on the 0.3.0 demo map, frame by frame on a virtual clock so motion is
smooth without a GPU, and one-map-two-readers.png sets the output of
wirehouse export beside the warehouse.
The README explained what Wirehouse draws but not why that is worth
having, and its images used repository paths that break on PyPI. It
now opens with the new demo, a Why section of what the tool guarantees
(evidence per connection, one offline file, any agent or none, safe to
share), a comparison with hand-drawn and Mermaid diagrams, the export
image and an eight-feature gallery. Images and links are absolute, so
the README also renders as the PyPI description.
@sardi-dev
sardi-dev merged commit de5c473 into main Oct 18, 2026
10 checks passed
@sardi-dev
sardi-dev deleted the docs/launch branch October 20, 2026 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant