Skip to content

docs(readme): launch refresh — blog-aligned screenshots and copy#2218

Open
tlongwell-block wants to merge 2 commits into
mainfrom
eva/readme-launch-refresh
Open

docs(readme): launch refresh — blog-aligned screenshots and copy#2218
tlongwell-block wants to merge 2 commits into
mainfrom
eva/readme-launch-refresh

Conversation

@tlongwell-block

Copy link
Copy Markdown
Collaborator

What

Launch-readiness refresh of the README, aligned with the engineering blog post (squareup/eng-blog-submissions#147). Screenshots replaced, copy surgically updated — same voice, same structure.

Why now

The blog post ends with "explore the code at github.com/block/buzz." Launch traffic lands here, and the README showed a different (and older) product than the post:

  • The hero screenshot was a real internal community — internal channel names in the sidebar (including a github.com/block/buzz PR URL), employee avatars, and message content discussing an auth-boundary question. Not the first image a security-curious launch reader should see.
  • channel-agents.png had a hearts animation mid-flight covering a message and a "Buzz (staging)" identity label.
  • Zero visual evidence of the forge, while the blog leads with a PR-view screenshot. The old gallery predates the forge UI (docs: add product screenshots to README #1168, June 22).

Changes

Screenshots (staged Honeycomb Studios set from the blog, 1800×1300):

  • Hero → engineering-channel.png (humans + agents, code, test results, issue link, release decision)
  • Gallery → agent-swarm.png (agents delegating/reviewing, decision returned to a human) + forge-pull-request.png (Git forge PR view); media-comments.png kept as the full-width breadth shot
  • Removed channel-thread.png, channel-agents.png, create-channel.png; scripts/seed-admin-dashboard.sh fixtures repointed (only other referencer, verified by repo-wide grep)

Copy (surgical, README register preserved):

  • Open with the blog's coordination thesis: "Models can do the work now. Teams still need somewhere to do it together."
  • Agent bullet now carries "authorization does not erase authorship"
  • Git bullet + status table separate what ships today (Git hosting + early forge UI) from what's next (branches-as-rooms, full merge workflow) — per VISION_PROJECTS.md's status table
  • Status table: huddles (voice relay + lifecycle events, kinds 48100-48103 shipped) and Buzz Mesh (opt-in build flag) added to works-today; push notifications moved 💭→🚧 (gateway shipped in feat(push): add public APNs gateway #1770, delivery pipeline in progress)
  • "the four vision docs" → all seven VISION*.md linked
  • One sentence in Architecture on CAS packfiles + TLA+-model-checked pointer swap (the blog's most technical claim, previously absent here)
  • Footer links buzz.xyz (verified live, HTTP 200)

Verification

  • Every image referenced in README.md exists in the tree; all three new PNGs decode (1800×1300 RGBA)
  • Repo-wide grep: no remaining references to the deleted files
  • git diff --check clean; pre-push hooks green (rust-tests, desktop-check, desktop-test, desktop-tauri-test, mobile-test, branch-skew)

Co-reviewed in #buzz-eng-blog with Wren — our independent reads converged on this exact set of changes.

…e blog post

Replace the README screenshot set with the staged Honeycomb Studios
assets from the launch blog post. The previous hero showed a real
internal community (internal channel names, employee avatars, and an
in-flight auth-boundary discussion) and predated the forge UI.

- Hero: engineering channel — humans and agents sharing code, test
  results, and a release decision
- Gallery: agent swarm coordination + Git forge PR view (new),
  media comments retained; agent-member and create-channel shots removed
- Copy: lead with the coordination thesis; 'authorization does not
  erase authorship' in the agent bullet; Git bullet now separates what
  ships today (hosting + early forge UI) from branches-as-rooms
- Status table: forge UI, huddles, and Buzz Mesh added to works-today;
  push notifications moved to being-wired-up (gateway shipped in #1770)
- Fix stale 'four vision docs' (there are seven); link buzz.xyz;
  one architecture sentence on CAS packfiles + TLA+-checked pointer swap
- seed-admin-dashboard.sh: repoint fixtures at the new image files

Co-authored-by: Tyler Longwell <tlongwell@block.xyz>
Signed-off-by: Tyler Longwell <tlongwell@block.xyz>
@tlongwell-block
tlongwell-block requested a review from a team as a code owner July 21, 2026 13:50
…riant

buzz-relay-mesh is a normal dependency of buzz-relay; activation is the
BUZZ_MESH env toggle (config.rs), default off. The Justfile mesh=1 flag
gates the desktop mesh-llm build feature, which is a different seam.

Co-authored-by: Tyler Longwell <tlongwell@block.xyz>
Signed-off-by: Tyler Longwell <tlongwell@block.xyz>
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.

2 participants