Repository navigation
docs: launch README and new demo media - #9
Merged
Merged
Conversation
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.
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
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.
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):approomdemo.mp4: the same at 1280 x 720, 25 fps (8.4 MB), for the release page and social posts.one-map-two-readers.png: the realwirehouse exportoutput 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/setTimeoutshim driven by Playwright), so motion is smooth even though the container has no GPU.docs(readme): the README leads with the value.--againstNote: image URLs point at
main, so the newone-map-two-readers.pngonly shows in the rendered README after this merges.How I checked it
python -m pytestpasses (153)docs/demo/index.htmlwith no console errors, and I checked frames from each scene.mainresolves to a file in this branch.CHANGELOG.mdupdated under UnreleasedGround rules
archmap.jsonor the HTML